snapshot 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28f9044173c73c9227c4e372ca91977e262a3166
-  data.tar.gz: 93c57e0423a893e5cb97ef1e3e7198cdeedb72c2
+  metadata.gz: 63d4849c32160441375a38343e1788f096de13b1
+  data.tar.gz: 3aeddc0b99d47752887b6164fb5b6bc13d4bae9d
 SHA512:
-  metadata.gz: c98f7667067c7ab9e0daee297868b1c9938668152de527ecd63752db9a510a35b77f73e97f87faff5adc7f0f84eba82e164d8673808b9fb4a2f138fbc8df2bf1
-  data.tar.gz: fb94311fe51e3f1f62e284fa46689797931e0f0cbc66d3f39d6b01420a8a4ea74487dff559063bbd8a9b57467fa176bde992f3b97ec77b758b096ffd4d9087e5
+  metadata.gz: 72791e5862dc34a5c23f357c4636519a3b7c180a1ed7ed038f20159bc6f29c2a683a490782a940b9bceece5bbd3ebfaa88f66f555d6e91921ccdf22feae2a88f
+  data.tar.gz: 962e41980b306165d10e226ba8a4228dde0f9dce9e79f3c513aafbadfe7088281673b7b39ede657e3e7d519558a2af12c1d2e7a63f631bc56b848d99e49bdc83

data/README.md

@@ -2,7 +2,8 @@
 <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>
+<a href="https://github.com/KrauseFx/PEM">PEM</a> &bull; 
+<a href="https://github.com/KrauseFx/sigh">Sigh</a>
 </p>
 -------
 
@@ -10,7 +11,7 @@
     <img src="assets/snapshot.png">
 </p>
 
-Snapshot - Create hundreds of iOS app screenshots
+Snapshot - Create iOS App Screenshots
 ============
 
 [![Twitter: @KauseFx](https://img.shields.io/badge/contact-@KrauseFx-blue.svg?style=flat)](https://twitter.com/KrauseFx)
@@ -41,13 +42,15 @@ Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
 
 
 -------
-[Features](#features) &bull;
-[Installation](#installation) &bull;
-[UI Automation](#ui-automation) &bull;
-[Quick Start](#quick-start) &bull;
-[Usage](#usage) &bull;
-[Tips](#tips) &bull;
-[Need help?](#need-help)
+<p align="center">
+    <a href="#features">Features</a> &bull; 
+    <a href="#installation">Installation</a> &bull; 
+    <a href="#ui-automation">UI Automation</a> &bull; 
+    <a href="#quick-start">Quick Start</a> &bull; 
+    <a href="#usage">Usage</a> &bull; 
+    <a href="#tips">Tips</a> &bull; 
+    <a href="#need-help">Need help?</a>
+</p>
 
 -------
 
@@ -56,7 +59,8 @@ Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
 - 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```
+- Very easy to integrate with [```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)
 
 After ```Snapshot``` successfully created new screenshots, it will generate a beautiful html file to get a quick overview of all screens:
@@ -184,12 +188,6 @@ By default, ```snapshot``` will look for your project in the current directory.
 project_path "./my_project/Project.xcworkspace"
 ```
 
-### HTML Report Path
-After all screenshots were created, a HTML file will be generated, to quickly get an overview of all screens on all devices. You can set a custom export path, to easily integrate the HTML report as ```Jenkins``` test result page.
-```ruby
-html_path "~/Desktop/screens.html"
-```
-
 ### iOS Version
 I'll try to keep the script up to date. If you need to change the iOS version, you can do it like this:
 
@@ -238,6 +236,14 @@ end
 In case you want to skip this process, just add ```skip_alpha_removal``` to your ```Snapfile```.
 
 # 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.
+
 ## Specify a custom ```Snapfile```
 
     snapshot --snapfile ./SpecialSnapfile

data/bin/snapshot

@@ -31,10 +31,11 @@ command :run do |c|
   c.syntax = 'snapshot'
   c.description = 'Run the script, to take all the screenshots'
   c.option '--snapfile STRING', String, 'Custom path for your Snapfile'
+  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
+    Snapshot::Runner.new.work(clean: !options.noclean)
   end
 end
 
@@ -45,4 +46,4 @@ command :init do |c|
   c.action do |args, options|
     Snapshot::SnapfileCreator.create('.')
   end
-end
+end

data/lib/assets/SnapfileTemplate

@@ -1,4 +1,4 @@
-# Uncommend the lines below you want to change by removing the # in the beginning
+# Uncomment the lines below you want to change by removing the # in the beginning
 
 # A list of devices you want to take the screenshots from
 devices([
@@ -30,10 +30,6 @@ screenshots_path "./screenshots"
 # By default, the latest version should be used automatically. If you want to change it, do it here
 # ios_version '8.1'
 
-# The path, on which the HTML file should be exported to
-# html_path './screenshots.html'
-
-
 # Custom Callbacks
 
 # setup_for_device_change do |device| 
@@ -52,4 +48,4 @@ screenshots_path "./screenshots"
 # teardown_device do |device|
 #   puts "Cleaning device #{device}"
 #   system("./cleanup.sh")
-# end
+# end

data/lib/snapshot/builder.rb

@@ -6,16 +6,18 @@ module Snapshot
 
 
     def initialize
-      FileUtils.rm_rf(BUILD_DIR)
+      
     end
 
-    def build_app
+    def build_app(clean: true)
+      FileUtils.rm_rf(BUILD_DIR) if clean
+
       command = SnapshotConfig.shared_instance.build_command
 
       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
-        command = generate_build_command
+        command = generate_build_command(clean: clean)
       end
 
       Helper.log.info "Building project '#{SnapshotConfig.shared_instance.project_name}' - this might take some time...".green
@@ -51,7 +53,7 @@ module Snapshot
         end
       end
 
-      def generate_build_command
+      def generate_build_command(clean: true)
         scheme = SnapshotConfig.shared_instance.scheme
 
         proj_path = SnapshotConfig.shared_instance.project_path
@@ -59,16 +61,21 @@ module Snapshot
         proj_key = 'workspace' if proj_path.end_with?'.xcworkspace'
 
         build_command = (DependencyChecker.xctool_installed? ? 'xctool' : 'xcodebuild')
+
+        actions = []
+        actions << 'clean' if clean
+        actions << "build"
+
         [
           build_command,
-          "-sdk iphonesimulator#{SnapshotConfig.shared_instance.ios_version}",
+          "-sdk iphonesimulator",
           "CONFIGURATION_BUILD_DIR='#{BUILD_DIR}/build'",
           "-#{proj_key} '#{proj_path}'",
           "-scheme '#{scheme}'",
           "DSTROOT='#{BUILD_DIR}'",
           "OBJROOT='#{BUILD_DIR}'",
           "SYMROOT='#{BUILD_DIR}'",
-          "clean build"
+          actions.join(' ')
         ].join(' ')
       end
   end

data/lib/snapshot/dependency_checker.rb

@@ -5,6 +5,7 @@ module Snapshot
       self.check_simulators
       self.check_xctool
       self.check_for_automation_subfolder
+      self.check_simctl
     end
 
     def self.check_xcode_select
@@ -24,6 +25,7 @@ module Snapshot
         Helper.log.fatal '#############################################################'
         Helper.log.fatal "# You have to add new simulators using Xcode"
         Helper.log.fatal "# Xcode => Window => Devices"
+        Helper.log.fatal "# Please run `instruments -s` to verify your xcode path"
         Helper.log.fatal '#############################################################'
         raise "Create the new simulators and run this script again"
       end
@@ -48,5 +50,11 @@ module Snapshot
         raise "Seems like you have an 'Automation' folder in the current directory. You need to delete/rename it!".red
       end
     end
+
+    def self.check_simctl
+      unless `xcrun simctl`.include?"openurl"
+        raise "Could not find `xcrun simctl`. Make sure you have the latest version of Xcode and Mac OS installed.".red
+      end
+    end
   end
 end

data/lib/snapshot/page.html.erb

@@ -40,10 +40,11 @@
             <% screens.each do |screen_path| %>
               <% next if screen_path.include?"_framed.png" %>
               <td>
+                <% path = screen_path.gsub("./screenshots/", "./") %>
                 <% screen_size = FastImage.size(screen_path) %>
-                <a href="<%= screen_path %>" target="_blank">
+                <a href="<%= path %>" target="_blank">
                   <img class="screenshot" 
-                         src="<%= screen_path %>",
+                         src="<%= path %>",
                        style="width: <%= [(screen_size[0] / divide_size_by).round, max_width].min %>px;" />
                 </a>
               </td>

data/lib/snapshot/reports_generator.rb

@@ -28,11 +28,10 @@ module Snapshot
       html_path = [lib_path, "snapshot/page.html.erb"].join('/')
       html = ERB.new(File.read(html_path)).result(binding) # http://www.rrn.dk/rubys-erb-templating-system
 
-      
-      export_path = SnapshotConfig.shared_instance.html_path
+      export_path = "#{screens_path}/screenshots.html"
       File.write(export_path, html)
 
-      Helper.log.info "Successfully created HTML file with all the screenshots: #{export_path}".green
+      Helper.log.info "Successfully created HTML file with an overview of all the screenshots: '#{File.expand_path(export_path)}'".green
     end
 
     private

data/lib/snapshot/runner.rb

@@ -8,18 +8,23 @@ module Snapshot
       Snapshot::DependencyChecker.check_dependencies
     end
 
-    def work
+    def work(clean: true)
       SnapshotConfig.shared_instance.js_file # to verify the file can be found
 
-      Builder.new.build_app
+      Builder.new.build_app(clean: clean)
+      @app_path = Dir.glob("/tmp/snapshot/build/*.app").first
 
       counter = 0
       errors = []
+
       SnapshotConfig.shared_instance.devices.each do |device|
         
         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
@@ -57,12 +62,11 @@ module Snapshot
 
     def run_tests(device, language)
       Helper.log.info "Running tests on #{device} in language #{language}".green
-      app_path = Dir.glob("/tmp/snapshot/build/*.app").first
 
       clean_old_traces
 
       ENV['SNAPSHOT_LANGUAGE'] = language
-      command = generate_test_command(device, language, app_path)
+      command = generate_test_command(device, language)
       Helper.log.debug command.yellow
       
       retry_run = false
@@ -98,6 +102,32 @@ 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
@@ -127,7 +157,7 @@ module Snapshot
       return Dir.glob("#{TRACE_DIR}/**/*.png").count
     end
 
-    def generate_test_command(device, language, app_path)
+    def generate_test_command(device, language)
       script_path = SnapshotConfig.shared_instance.js_file
 
       [
@@ -135,7 +165,7 @@ module Snapshot
         "-w '#{device}'",
         "-D '#{TRACE_DIR}/trace'",
         "-t 'Automation'",
-        "'#{app_path}'",
+        "'#{@app_path}'",
         "-e UIARESULTSPATH '#{TRACE_DIR}'",
         "-e UIASCRIPT '#{script_path}'",
         "-AppleLanguages '(#{language})'",

data/lib/snapshot/snapshot_config.rb

@@ -25,9 +25,6 @@ module Snapshot
     # @return (String) The path, in which the screenshots should be stored
     attr_accessor :screenshots_path
 
-    # @return (String) The path, in which the HTML file should be exported to
-    attr_accessor :html_path
-
     # @return (String) The build command, wich should build the app to '/tmp/snapshot'
     attr_accessor :build_command
 
@@ -48,12 +45,14 @@ module Snapshot
       path ||= './Snapfile'
       set_defaults
 
-      if path and File.exists?path
+      if File.exists?path
+        Helper.log.info "Using '#{path}'".green
         self.snapshot_file = SnapshotFile.new(path, self)
       else
         if path != './Snapfile'
           raise "Could not find Snapfile at path '#{path}'. Make sure you pass the full path, including 'Snapfile'".red
         else
+          # Using default settings, since user didn't provide a path
           Helper.log.error "Could not find './Snapfile'. It is recommended to create a file using 'snapshot init' into the current directory. Using the defaults now.".red
         end
       end
@@ -81,8 +80,6 @@ module Snapshot
       self.project_path = (Dir.glob("./*.xcworkspace").first rescue nil) # prefer workspaces ofc
       self.project_path ||= (Dir.glob("./*.xcodeproj").first rescue nil)
 
-      self.html_path = './screenshots.html'
-
       empty = Proc.new {}
       self.blocks = {
         setup_for_device_change: empty, 
@@ -102,7 +99,7 @@ module Snapshot
 
     # Returns the file name of the project
     def project_name
-      (self.project_path.split('/').last.split('.').first rescue nil)
+      File.basename(self.project_path, ".*" )
     end
 
     # The JavaScript UIAutomation file
@@ -120,7 +117,7 @@ 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 '#{project_path.split('/')[0..-2].join('/')}'; xcodebuild -list"
+        command = "cd '#{File.expand_path('..', project_path)}'; xcodebuild -list"
         schemes = `#{command}`.split("Schemes:").last.split("\n").each { |a| a.strip! }.delete_if { |a| a == '' }
         Helper.log.debug "Found available schemes: #{schemes}"
 

data/lib/snapshot/snapshot_file.rb

@@ -36,14 +36,10 @@ module Snapshot
         when :js_file
           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.gsub("~", ENV['HOME'])
+          @config.manual_js_file = File.expand_path(value)
         when :screenshots_path
           raise "screenshots_path has to be an String".red unless value.kind_of?String
-          @config.screenshots_path = value.gsub("~", ENV['HOME'])
-        when :html_path
-          raise "html_path has to be an String".red unless value.kind_of?String
-          @config.html_path = value.gsub("~", ENV['HOME'])
-          @config.html_path = @config.html_path + "/screenshots.html" unless @config.html_path.include?".html"
+          @config.screenshots_path = File.expand_path(value)
         when :build_command
           raise "build_command has to be an String".red unless value.kind_of?String
           @config.build_command = value
@@ -52,10 +48,11 @@ module Snapshot
         when :project_path
           raise "project_path has to be an String".red unless value.kind_of?String
 
-          if File.exists?value and (value.end_with?".xcworkspace" or value.end_with?".xcodeproj")
-            @config.project_path = value.gsub("~", ENV['HOME'])
+          path = File.expand_path(value)
+          if File.exists?path and (path.end_with?".xcworkspace" or path.end_with?".xcodeproj")
+            @config.project_path = path
           else
-            raise "The given project_path '#{value}' could not be found. Make sure to include the extension as well.".red
+            raise "The given project_path '#{path}' could not be found. Make sure to include the extension as well.".red
           end
 
         # Blocks

data/lib/snapshot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json