snapshot 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2062cd7ffe2f73085accb032e996a17a6bae3366
-  data.tar.gz: 28cece95de94cbcd1ce1b01af91cd49686440799
+  metadata.gz: a66a1a9280b45c2ab1a4791bc85878ea76dc9929
+  data.tar.gz: c0fdea38499e026ba90f5d50064308c1da2c488a
 SHA512:
-  metadata.gz: 54f045eba2b950217cb20b701166d3301909217d45f5f13fe7e7379ff6da1c32bffa1fb956148674726a3b6ee73af9dae831d371db4374c904c9d53f817f3e85
-  data.tar.gz: 82935ebf00ecdbab062e4353b69debb8fd6744eccf5fe3364993784f40b2051d2ee8fa39150ec304eeecbab8a730a806786d4174df3827679790f207aed6527f
+  metadata.gz: 95c00e2071a985cb2430f42fded88f4b208ed94432df393b8637fca9c2e407b55c2c9cb89304f98fe9d4a5a2cf253152bbe0ea9640eabc56439d36ad08503190
+  data.tar.gz: 6ea6bf77f028ed25ce463a2ab85c0164c2bf313426528c5463698154a93f0472260ec9265cfb598bd6f146fcf502f5358d297469f292b3e7b6ea57383924212e

data/README.md

@@ -22,6 +22,7 @@ Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
 -------
 [Features](#features) •
 [Installation](#installation) •
+[UI Automation](#ui-automation) •
 [Quick Start](#quick-start) •
 [Usage](#usage) •
 [Tips](#tips) •
@@ -35,6 +36,16 @@ Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
 - 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```
+- ```Snapshot``` automatically waits for network requests to be finished before taking a screenshot (we don't want loading images in the App Store screenshots)
+
+## Why?
+This gem automatically switches the language and device type and runs the automation script to take all screenshots.
+
+**Why use ```snapshot``` instead of....**
+
+- **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 ist 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.
 
 # Installation
 
@@ -45,6 +56,28 @@ Install the gem
 Make sure, you have the latest version of the Xcode command line tools installed:
 
     xcode-select --install
+    
+# UI Automation
+
+## Get started
+This project uses Apple's ```UI Automation``` under the hood. I will not go into detail on how to write scripts. 
+
+Here a few links to get started:
+
+- [Apple's official documentation](https://developer.apple.com/library/ios/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UsingtheAutomationInstrument/UsingtheAutomationInstrument.html)
+- [UI Automation: An Introduction (cocoamanifest.net)](http://cocoamanifest.net/articles/2011/05/uiautomation-an-introduction.html)
+- [Functional Testing UI Automation (mattmccomb.com)](http://www.mattmccomb.com/blog/2013/06/02/ios-functional-testing-with-uiautomation/)
+
+## Record your first script
+Profile your app (CMD + I), choose ```Automation``` and click the Record button on the bottom of the window.
+
+This will get you started. Save the generated file with the extension ```js``` into your project root. 
+
+Add ```#import "SnapshotHelper.js"``` on the top of your file.
+
+Now you can use ```captureLocalizedScreenshot('0-name')``` to take a snapshot.
+
+You can take a look at the example project to play around with it.
 
 # Quick Start
 
@@ -92,7 +125,7 @@ languages([
 ])
 ```
 
-### Javascript file
+### JavaScript file
 Usually ```snapshot``` automatically finds your JavaScript file. If that's not the case, you can pass the path 
 to your test file.
 ```ruby
@@ -105,6 +138,12 @@ To not be asked which scheme to use, just set it like this:
 scheme "Name"
 ```
 
+### Screenshots output path
+All generated screenshots will be stored in the given path.
+```ruby
+screenshots_path './screenshots'
+```
+
 ### Project Path
 By default, ```snapshot``` will look for your project in the current directory. If it is located somewhere else, pass your custom path:
 ```ruby
@@ -128,7 +167,7 @@ ios_version "9.0"
 ## Use a clean status bar
 You can use [SimulatorStatusMagic](https://github.com/shinydevelopment/SimulatorStatusMagic) to clean up the status bar.
 
-## Editing the ```Deliverfile```
+## Editing the ```Snapfile```
 Change syntax highlighting to *Ruby*.
 
 # Need help?

data/lib/snapshot.rb

@@ -7,8 +7,6 @@ require 'snapshot/builder'
 require 'snapshot/snapshot_file'
 require 'snapshot/languages'
 
-require 'pry' # TODO: Remove
-
 # Third Party code
 require 'colored'
 

data/lib/snapshot/builder.rb

@@ -6,14 +6,14 @@ module Snapshot
 
 
     def initialize
-
+      FileUtils.rm_rf(BUILD_DIR)
     end
 
     def build_app
       raise "Could not find project. Please pass the path to your project using 'project_path'.".red unless SnapshotConfig.shared_instance.project_name
       command = generate_build_command
 
-      Helper.log.info "Building project '#{SnapshotConfig.shared_instance.project_name}'... this might take some time...".green
+      Helper.log.info "Building project '#{SnapshotConfig.shared_instance.project_name}' - this might take some time...".green
       Helper.log.debug command.yellow
 
       all_lines = []
@@ -49,12 +49,16 @@ module Snapshot
       def generate_build_command
         scheme = SnapshotConfig.shared_instance.scheme
 
+        proj_path = SnapshotConfig.shared_instance.project_path
+        proj_key = 'project'
+        proj_key = 'workspace' if proj_path.end_with?'.xcworkspace'
+
         build_command = (DependencyChecker.xctool_installed? ? 'xctool' : 'xcodebuild')
         [
           build_command,
           "-sdk iphonesimulator#{SnapshotConfig.shared_instance.ios_version}",
           "CONFIGURATION_BUILD_DIR='#{BUILD_DIR}/build'",
-          "-workspace '#{SnapshotConfig.shared_instance.project_path}'",
+          "-#{proj_key} '#{proj_path}'",
           "-scheme '#{scheme}'",
           "-configuration Debug",
           "DSTROOT='#{BUILD_DIR}'",

data/lib/snapshot/runner.rb

@@ -9,8 +9,6 @@ module Snapshot
     end
 
     def work
-      @screenshots_path = './screenshots'
-
       SnapshotConfig.shared_instance.js_file # to verify the file can be found
 
       Builder.new.build_app
@@ -27,6 +25,9 @@ module Snapshot
 
         end
       end
+
+      Helper.log.info "Successfully finished generating screenshots.".green
+      Helper.log.info "Check it out here: #{SnapshotConfig.shared_instance.screenshots_path}".green
     end
 
     def clean_old_traces
@@ -83,8 +84,11 @@ module Snapshot
     end
 
     def copy_screenshots(language)
-      resulting_path = [@screenshots_path, language].join('/')
+      resulting_path = [SnapshotConfig.shared_instance.screenshots_path, language].join('/')
+      resulting_path.gsub!("~", ENV['HOME']) # some strange bug requires this
+
       FileUtils.mkdir_p resulting_path
+
       Dir.glob("#{TRACE_DIR}/**/*.png") do |file|
         FileUtils.cp_r(file, resulting_path + '/')
       end

data/lib/snapshot/snapshot_config.rb

@@ -22,6 +22,9 @@ module Snapshot
     # @return (String) The path to the JavaScript file to use
     attr_accessor :manual_js_file
 
+    # @return (String) The path, in which the screenshots should be stored
+    attr_accessor :screenshots_path
+
 
     # A shared singleton
     def self.shared_instance
@@ -46,7 +49,7 @@ module Snapshot
         "iPhone 6 (#{self.ios_version} Simulator)",
         "iPhone 6 Plus (#{self.ios_version} Simulator)",
         "iPhone 5 (#{self.ios_version} Simulator)",
-        "iPhone 4S (#{self.ios_version} Simulator)"
+        "iPhone 4s (#{self.ios_version} Simulator)"
       ]
 
       self.languages = [
@@ -54,6 +57,8 @@ module Snapshot
         'en-US'
       ]
 
+      self.screenshots_path = './screenshots'
+
       self.project_path = (Dir.glob("./*.xcworkspace").first rescue nil)
       self.project_path ||= (Dir.glob("./*.xcodeproj").first rescue nil)
     end
@@ -82,6 +87,7 @@ module Snapshot
         schemes = `#{command}`.split("Schemes:").last.split("\n").each { |a| a.strip! }.delete_if { |a| a == '' }
         Helper.log.debug "Found available schemes: #{schemes}"
 
+        self.manual_scheme = schemes.first if schemes.count == 1
 
         if self.manual_scheme
           if not schemes.include?manual_scheme

data/lib/snapshot/snapshot_file.rb

@@ -33,6 +33,9 @@ module Snapshot
           raise "js_file has to be an String".red unless value.kind_of?String
           raise "js_file at path '#{value}' not found".red unless File.exists?value
           @config.manual_js_file = value
+        when :screenshots_path
+          raise "screenshots_path has to be an String".red unless value.kind_of?String
+          @config.screenshots_path = value
         when :project_path
           raise "project_path has to be an String".red unless value.kind_of?String
 
@@ -48,14 +51,16 @@ module Snapshot
 
     def verify_devices(value)
       raise "Devices has to be an array".red unless value.kind_of?Array
+      @config.devices = []
       value.each do |current|
         current += " (#{@config.ios_version} Simulator)" unless current.include?"Simulator"
 
         unless SnapshotFile.available_devices.include?current
           raise "Device '#{current}' not found. Available device types: #{SnapshotFile.available_devices}".red
+        else
+          @config.devices << current
         end
       end
-      @config.devices = value
     end
 
     def verify_languages(value)

data/lib/snapshot/version.rb

@@ -1,3 +1,3 @@
 module Snapshot
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Felix Krause