snapshot 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63d4849c32160441375a38343e1788f096de13b1
-  data.tar.gz: 3aeddc0b99d47752887b6164fb5b6bc13d4bae9d
+  metadata.gz: e60a5446d5764cc0d02230645802b5aaae8ccf25
+  data.tar.gz: 9724d4807becb6ada750263d8db89c59b91ca44e
 SHA512:
-  metadata.gz: 72791e5862dc34a5c23f357c4636519a3b7c180a1ed7ed038f20159bc6f29c2a683a490782a940b9bceece5bbd3ebfaa88f66f555d6e91921ccdf22feae2a88f
-  data.tar.gz: 962e41980b306165d10e226ba8a4228dde0f9dce9e79f3c513aafbadfe7088281673b7b39ede657e3e7d519558a2af12c1d2e7a63f631bc56b848d99e49bdc83
+  metadata.gz: d2c0bfd23a066f1923377b974635cb00df298b98cd6f9c728cba0d49f34e8d2c86904fac666448ba7346ef488708065eed2bd49343be3e9cf6b7af3eb9b35de8
+  data.tar.gz: e8bf9580d239021c10392b9e24408b5bce3923dfe2d396b763b7ab974fdbe77c58e33be0e320d8b211d3b6689f89c56b306074873a4ca6ee1e55661718d2153e

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Felix Krause
+Copyright (c) 2015 Felix Krause
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,9 +1,16 @@
+<h3 align="center">
+  <a href="https://github.com/KrauseFx/fastlane">
+    <img src="assets/fastlane.png" width="150" />
+    <br />
+    fastlane
+  </a>
+</h3>
 <p align="center">
-<a href="https://github.com/KrauseFx/deliver">Deliver</a> &bull; 
-<b>Snapshot</b> &bull; 
-<a href="https://github.com/KrauseFx/frameit">FrameIt</a> &bull; 
-<a href="https://github.com/KrauseFx/PEM">PEM</a> &bull; 
-<a href="https://github.com/KrauseFx/sigh">Sigh</a>
+  <a href="https://github.com/KrauseFx/deliver">deliver</a> &bull; 
+  <b>snapshot</b> &bull; 
+  <a href="https://github.com/KrauseFx/frameit">frameit</a> &bull; 
+  <a href="https://github.com/KrauseFx/PEM">PEM</a> &bull; 
+  <a href="https://github.com/KrauseFx/sigh">sigh</a>
 </p>
 -------
 
@@ -11,13 +18,14 @@
     <img src="assets/snapshot.png">
 </p>
 
-Snapshot - Create iOS App Screenshots
+snapshot
 ============
 
 [![Twitter: @KauseFx](https://img.shields.io/badge/contact-@KrauseFx-blue.svg?style=flat)](https://twitter.com/KrauseFx)
 [![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/KrauseFx/snapshot/blob/master/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
 
 You have an iPhone app. You support 20 languages. You updated the design. You want to release the update to the App Store.
 What's missing?
@@ -38,7 +46,7 @@ It's hard to get everything right!
 
 This gem solves all those problems. It will run completely in the background - you can do something else, while your computer takes the screenshots for you.
 
-Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
+Get in contact with the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
 
 
 -------
@@ -54,17 +62,22 @@ Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
 
 -------
 
+<h5 align="center"><code>snapshot</code> is part of <a href="http://fastlane.tools">fastlane</a>: connect all deployment tools into one streamlined workflow.</h5>
+
+
 
 # Features
 - 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
-- Very easy to integrate with [```deliver```](https://github.com/KrauseFx/deliver)
+- Integrated with [`fastlane`](http://fastlane.tools) and [`deliver`](https://github.com/KrauseFx/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)
+- ```snapshot``` automatically waits for network requests to be finished before taking a screenshot (we don't want loading images in the App Store screenshots)
+
+After ```snapshot``` successfully created new screenshots, it will generate a beautiful html file to get a quick overview of all screens:
 
-After ```Snapshot``` successfully created new screenshots, it will generate a beautiful html file to get a quick overview of all screens:
-![assets/htmlPage.png](assets/htmlPage.png)
+
+![assets/htmlPagePreviewFade.jpg](assets/htmlPagePreviewFade.jpg)
 
 ## Why?
 This gem automatically switches the language and device type and runs the automation script to take all screenshots.
@@ -81,7 +94,7 @@ This gem automatically switches the language and device type and runs the automa
 I've been using many other solutions out there. Unfortunately none of them were perfect. The biggest issue was random timeouts of ```Instruments``` when starting the script. This problem is solved with ```snapshot```
 
 - **UI Automation in Instruments**: Instruments can only run your app on one device in one language. You have to manually switch it.
-- **[ui-screen-shooter](https://github.com/jonathanpenn/ui-screen-shooter)**: This is the best alternative out there right now. It's based on AppleScript, you can not update it properly and there are quite some hacks in there. ```Snapshot``` uses a very similar technique - just in a clean and maintainable Ruby gem.
+- **[ui-screen-shooter](https://github.com/jonathanpenn/ui-screen-shooter)**: This is the best alternative out there right now. It's based on AppleScript, you can not update it properly and there are quite some hacks in there. ```snapshot``` uses a very similar technique - just in a clean and maintainable Ruby gem.
 - **[Subliminal](https://github.com/inkling/Subliminal)**: A good approach to write the interaction code in Objective C. Unfortunately it has a lot of open issues with the latest release of Xcode. Also, it requires modifications of your Xcode project and schemes, which might break some other things.
 
 # Installation
@@ -129,12 +142,21 @@ From now on, you can run ```snapshot``` to create new screenshots of your app.
 
 # Usage
 
-Why should you have to remember complicated commands and parameters?
+```
+snapshot
+```
 
-Store your configuration in a text file to easily take screenshots from any computer.
+To skip cleaning the project:
+```
+snapshot --noclean
+```
 
 ## Snapfile
 
+#### Why should you have to remember complicated commands and parameters?
+
+Store your configuration in a text file to easily take screenshots from any computer.
+
 Create a file called ```Snapfile``` in your project directory.
 Once you created your configuration, just run ```snapshot```.
 
@@ -237,12 +259,24 @@ In case you want to skip this process, just add ```skip_alpha_removal``` to your
 
 # Tips
 
-## Other helpful tools
-Check out other tools in this collection to speed up your deployment process:
-- [```deliver```](https://github.com/KrauseFx/deliver): Deploy screenshots, app metadata and app updates to the App Store using just one command.
-- [```FrameIt```](https://github.com/KrauseFx/frameit): Want a device frame around your screenshot? Do it in an instant!
-- [```PEM```](https://github.com/KrauseFx/pem): Tired of manually creating and maintaining your push certification profiles?
-- [```sigh```](https://github.com/KrauseFx/sigh): Because you would rather spend your time building stuff than fighting provisioning.
+## [`fastlane`](http://fastlane.tools) Toolchain
+
+- [`fastlane`](http://fastlane.tools): Connect all deployment tools into one streamlined workflow
+- [`deliver`](https://github.com/KrauseFx/deliver): Upload screenshots, metadata and your app to the App Store using a single command
+- [`frameit`](https://github.com/KrauseFx/frameit): Quickly put your screenshots into the right device frames
+- [`PEM`](https://github.com/KrauseFx/pem): Automatically generate and renew your push notification profiles
+- [`sigh`](https://github.com/KrauseFx/sigh): Because you would rather spend your time building stuff than fighting provisioning
+
+## 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.
+
+You can disable this dialog, running the following command:
+```
+security authorizationdb read system.privilege.taskport > /tmp/system.privilege.taskport.plist
+/usr/libexec/PlistBuddy -c "Set :allow-root true" /tmp/system.privilege.taskport.plist
+sudo security authorizationdb write system.privilege.taskport < /tmp/system.privilege.taskport.plist
+```
+I found this solution in the [`Subliminal` wiki](https://github.com/inkling/Subliminal/wiki/Continuous-Integration#faq).
 
 ## Specify a custom ```Snapfile```
 
@@ -267,8 +301,8 @@ Unfortunately ```Instruments``` sometimes decides, to not respond to anything. W
 The only way to fix this, is a restart of the Mac. 
 
 # Need help?
-- If there is a technical problem with ```Snapshot```, submit an issue. Run ```snapshot --trace``` to get the stacktrace.
-- I'm available for contract work - drop me an email: snapshot@felixkrause.at
+- If there is a technical problem with ```snapshot```, submit an issue. Run ```snapshot --trace``` to get the stacktrace.
+- I'm available for contract work - drop me an email: snapshot@krausefx.com
 
 # License
 This project is licensed under the terms of the MIT license. See the LICENSE file.

data/bin/snapshot

@@ -4,8 +4,6 @@ $:.push File.expand_path("../../lib", __FILE__)
 
 require 'snapshot'
 require 'commander/import'
-require 'snapshot/update_checker'
-require 'snapshot/dependency_checker'
 require 'snapshot/snapfile_creator'
 require 'snapshot/snapshot_config'
 
@@ -14,17 +12,15 @@ HighLine.track_eof = false
 
 # Commander
 program :version, Snapshot::VERSION
-program :description, 'CLI for \'Snapshot\' - Automatic taking of screenshots on all simulator types in all languages.'
-program :help, 'Author', 'Felix Krause <krausefx@gmail.com>'
-program :help, 'Website', 'http://felixkrause.at'
+program :description, 'CLI for \'Snapshot\' - Automate taking localized screenshots of your iOS app on every device'
+program :help, 'Author', 'Felix Krause <snapshot@krausefx.com>'
+program :help, 'Website', 'http://fastlane.tools'
 program :help, 'GitHub', 'https://github.com/krausefx/snapshot'
 program :help_formatter, :compact
 
 global_option('--verbose') { $verbose = true }
 
 
-Snapshot::UpdateChecker.verify_latest_version
-
 default_command :run
 
 command :run do |c|
@@ -34,8 +30,11 @@ command :run do |c|
   c.option '--noclean', 'Skips the clean process when running snapshot.'
 
   c.action do |args, options|
-    Snapshot::SnapshotConfig.shared_instance(options.snapfile) if options.snapfile # to set the custom Snapfile path if given
-    Snapshot::Runner.new.work(clean: !options.noclean)
+    path = (Snapshot::Helper.fastlane_enabled?? './fastlane' : '.')
+    Dir.chdir(path) do # switch the context
+      Snapshot::SnapshotConfig.shared_instance(options.snapfile)
+      Snapshot::Runner.new.work(clean: !options.noclean)
+    end
   end
 end
 
@@ -44,6 +43,7 @@ command :init do |c|
   c.description = "Creates a new Snapfile in the current directory"
 
   c.action do |args, options|
-    Snapshot::SnapfileCreator.create('.')
+    path = (Snapshot::Helper.fastlane_enabled?? './fastlane' : '.')
+    Snapshot::SnapfileCreator.create(path)
   end
-end
+end

data/lib/snapshot/builder.rb

@@ -1,5 +1,3 @@
-require 'snapshot/dependency_checker'
-
 module Snapshot
   class Builder
     BUILD_DIR = '/tmp/snapshot'
@@ -16,7 +14,7 @@ module Snapshot
 
       if not command
         # That's the default case, user did not provide a custom build_command
-        raise "Could not find project. Please pass the path to your project using 'project_path'.".red unless SnapshotConfig.shared_instance.project_name
+        raise "Could not find project. Please pass the path to your project using 'project_path'.".red unless SnapshotConfig.shared_instance.project_path
         command = generate_build_command(clean: clean)
       end
 
@@ -30,7 +28,7 @@ module Snapshot
           all_lines << line
           begin
             parse_build_line(line) if line.length > 2
-          rescue Exception => ex
+          rescue => ex
             Helper.log.fatal all_lines.join("\n")
             raise ex
           end

data/lib/snapshot/helper.rb

@@ -47,5 +47,9 @@ module Snapshot
       `xcode-select -p`.gsub("\n", '') + "/"
     end
 
+    def self.fastlane_enabled?
+      # This is called from the root context on the first start
+      @@enabled ||= File.directory?"./fastlane"
+    end
   end
 end

data/lib/snapshot/runner.rb

@@ -4,10 +4,6 @@ module Snapshot
   class Runner
     TRACE_DIR = '/tmp/snapshot_traces'
 
-    def initialize
-      Snapshot::DependencyChecker.check_dependencies
-    end
-
     def work(clean: true)
       SnapshotConfig.shared_instance.js_file # to verify the file can be found
 
@@ -22,17 +18,12 @@ module Snapshot
         SnapshotConfig.shared_instance.blocks[:setup_for_device_change].call(device)  # Callback
 
         SnapshotConfig.shared_instance.languages.each do |language|
-          
-          # uninstall_app(device)
-
           SnapshotConfig.shared_instance.blocks[:setup_for_language_change].call(language, device) # Callback
 
           begin
             errors.concat(run_tests(device, language))
             counter += copy_screenshots(language)
-          rescue SystemExit, Interrupt => ex
-            raise ex # system interrupted exception (ctrl + C)
-          rescue StandardError => ex
+          rescue => ex
             Helper.log.error(ex)
           end
           SnapshotConfig.shared_instance.blocks[:teardown_language].call(language, device) # Callback
@@ -102,32 +93,6 @@ module Snapshot
       return errors
     end
 
-    # def uninstall_app(device)
-    #   def com(str)
-    #     puts str.yellow
-    #     puts `#{str}`
-    #     sleep 1.0
-    #   end
-
-    #   def find_simulator(name)
-    #     all = `instruments -s`.split("\n")
-    #     all.each do |current|
-    #       return current.match(/\[(.*)\]/)[1] if current.include?name
-    #     end
-    #     raise "Could not find simulator '#{name}' to install the app on."
-    #   end
-
-    #   udid = find_simulator(device)
-    #   com("killall 'iOS Simulator'")
-    #   com("xcrun simctl boot '#{udid}'")
-    #   com("xcrun simctl uninstall '#{udid}' 'net.sunapps.123'") # TODO: Dynamic
-    #   sleep 3
-    #   com("xcrun simctl install '#{udid}' '#{@app_path}'")
-    #   com("xcrun simctl shutdown '#{udid}'")
-    #   sleep 1
-    #   com("killall 'iOS Simulator'")
-    # end
-
     def parse_test_line(line)
       if line =~ /.*Target failed to run.*/
         return :retry

data/lib/snapshot/snapfile_creator.rb

@@ -1,8 +1,10 @@
+require 'snapshot/helper'
+
 module Snapshot
   class SnapfileCreator
     # This method will take care of creating a Snapfile
     def self.create(path)
-      snapfile_path = [path, 'Snapfile'].join("/")
+      snapfile_path = File.join(path, 'Snapfile')
 
       raise "Snapfile already exists at path '#{snapfile_path}'. Run 'snapshot' to use Snapshot.".red if File.exists?(snapfile_path)
 

data/lib/snapshot/snapshot_config.rb

@@ -77,8 +77,14 @@ module Snapshot
 
       self.screenshots_path = './screenshots'
 
-      self.project_path = (Dir.glob("./*.xcworkspace").first rescue nil) # prefer workspaces ofc
-      self.project_path ||= (Dir.glob("./*.xcodeproj").first rescue nil)
+      folders = ["./*.xcworkspace"] # we prefer workspaces
+      folders << "./*.xcodeproj"
+      folders << "../*.xcworkspace"
+      folders << "../*.xcodeproj"
+
+      folders.each do |current|
+        self.project_path ||= (File.expand_path(Dir[current].first) rescue nil)
+      end
 
       empty = Proc.new {}
       self.blocks = {
@@ -117,7 +123,11 @@ module Snapshot
     # The scheme to use (either it's set, or there is only one, or user has to enter it)
     def scheme
       begin
-        command = "cd '#{File.expand_path('..', project_path)}'; xcodebuild -list"
+        project_key = 'project'
+        project_key = 'workspace' if project_path.end_with?'.xcworkspace'
+        command = "xcodebuild -#{project_key} '#{project_path}' -list"
+        Helper.log.debug command
+        
         schemes = `#{command}`.split("Schemes:").last.split("\n").each { |a| a.strip! }.delete_if { |a| a == '' }
         Helper.log.debug "Found available schemes: #{schemes}"
 
@@ -145,7 +155,7 @@ module Snapshot
           end
           return self.manual_scheme
         end
-      rescue Exception => ex
+      rescue => ex
         raise "Could not fetch available schemes: #{ex}".red
       end
     end

data/lib/snapshot/snapshot_file.rb

@@ -54,7 +54,8 @@ module Snapshot
           else
             raise "The given project_path '#{path}' could not be found. Make sure to include the extension as well.".red
           end
-
+        when :html_path
+          raise "The `html_path` options was removed from snapshot. The default location is now the screenshots path. Please remove this line from your 'Snapfile'.".red
         # Blocks
         when :setup_for_device_change, :teardown_device, :setup_for_language_change, :teardown_language
           raise "#{method_sym} needs to have a block provided." unless block_given?

data/lib/snapshot/update_checker.rb

@@ -25,7 +25,7 @@ module Snapshot
         if latest and Gem::Version.new(latest) > Gem::Version.new(current_version)
           return true
         end
-      rescue Exception => ex
+      rescue => ex
         Helper.log.debug(ex)
         Helper.log.error("Could not check if 'snapshot' is up to date.")
       end

data/lib/snapshot/version.rb

@@ -1,3 +1,3 @@
 module Snapshot
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/lib/snapshot.rb

@@ -8,10 +8,13 @@ require 'snapshot/snapshot_file'
 require 'snapshot/reports_generator'
 require 'snapshot/screenshot_flatten'
 require 'snapshot/simulators'
+require 'snapshot/update_checker'
+require 'snapshot/dependency_checker'
 
 # Third Party code
 require 'colored'
 
 module Snapshot
-  # Your code goes here...
+  Snapshot::UpdateChecker.verify_latest_version
+  Snapshot::DependencyChecker.check_dependencies
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -164,9 +164,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Take the pain out of taking iOS app screenshots.
+description: Automate taking localized screenshots of your iOS app on every device
 email:
-- krausefx@gmail.com
+- snapshot@krausefx.com
 executables:
 - snapshot
 extensions: []
@@ -192,7 +192,7 @@ files:
 - lib/snapshot/snapshot_file.rb
 - lib/snapshot/update_checker.rb
 - lib/snapshot/version.rb
-homepage: http://felixkrause.at
+homepage: http://fastlane.tools
 licenses:
 - MIT
 metadata: {}
@@ -215,6 +215,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Snapshot - Create hundreds of iOS app screenshots automatically
+summary: Automate taking localized screenshots of your iOS app on every device
 test_files: []
 has_rdoc: