snapshot 0.1.0 → 0.2.1.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a66a1a9280b45c2ab1a4791bc85878ea76dc9929
-  data.tar.gz: c0fdea38499e026ba90f5d50064308c1da2c488a
+  metadata.gz: 6c2536f41985227165492325889d7840b12dde0d
+  data.tar.gz: 35a2065343d4f96e79a1a47be751c44c466cc134
 SHA512:
-  metadata.gz: 95c00e2071a985cb2430f42fded88f4b208ed94432df393b8637fca9c2e407b55c2c9cb89304f98fe9d4a5a2cf253152bbe0ea9640eabc56439d36ad08503190
-  data.tar.gz: 6ea6bf77f028ed25ce463a2ab85c0164c2bf313426528c5463698154a93f0472260ec9265cfb598bd6f146fcf502f5358d297469f292b3e7b6ea57383924212e
+  metadata.gz: 41fa64e0018686214581fbb62e6cb17211b59954274cf77f24b746ba57cd2c8af31269fccbfadac6be89fc060d7aad8bb347d118d65472865d378f9b1d41822c
+  data.tar.gz: 94751b98456aa3a4e824cb37413a8c398b6643a0ef86134b3b3eb9a881a5e581da2bc64fc09448b3af042f5998d71ac822dd58fa012afa663b303d60e1b3eff4

data/README.md

@@ -6,15 +6,27 @@ Snapshot - Create hundreds of iOS app screenshots
 ============
 
 [![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/deliver/blob/develop/LICENSE)
-[![Gem](https://img.shields.io/gem/v/deliver.svg?style=flat)](http://rubygems.org/gems/deliver)
-[![Build Status](https://img.shields.io/travis/KrauseFx/deliver/master.svg?style=flat)](https://travis-ci.org/KrauseFx/deliver) -->
+[![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)
 
-Taking perfect iOS screenshots is difficult. You usually want them to look the same in **all languages** on **all devices**. 
+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? *
 
-This easily results in over **300 screenshots** you have to create. 
+**New Screenshots**
 
-Uploading them is really easy, using [```deliver```](https://github.com/KrauseFx/deliver).
+You want them to look **perfect** and **gorgeous**. They should show the same screens on all devices in all languages.
+
+You have to manually create 20 (languages) x 4 (devices) x 5 (screenshots) = **400 screenshots**.
+
+It's hard to get everything right!
+
+- New screenshots with every (design) update
+- No loading indicators
+- Same content / screens
+- [Clean Status Bar](#use-a-clean-status-bar)
+- Uploading screenshots ([```deliver```](https://github.com/KrauseFx/deliver) is your friend)
+
+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)
 
@@ -41,11 +53,20 @@ Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
 ## Why?
 This gem automatically switches the language and device type and runs the automation script to take all screenshots.
 
-**Why use ```snapshot``` instead of....**
+### Why should I automate this process?
+- It takes **hours** to take screenshots
+- It is an integration test: You can test for UI elements and other things inside your scripts
+- Be so nice, and provide new screenshots with every App Store update. Your customers deserve it
+- You realise, there is a spelling mistake in one of the screens? Well, just correct it and re-run the script.
+- You get a great overview of all your screens, running on all available simulators without the need to manually start it hundreds of times
+
+###Why use ```snapshot``` instead of....
+
+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 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.
+- **[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
 
@@ -68,21 +89,19 @@ Here a few links to get started:
 - [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. 
+# Quick Start
 
-Add ```#import "SnapshotHelper.js"``` on the top of your file.
+## Record your first script
 
-Now you can use ```captureLocalizedScreenshot('0-name')``` to take a snapshot.
+- 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. 
+- Copy the ```SnapshotHelper.js``` file from the example folder to your project.
+- Add ```#import "SnapshotHelper.js"``` on the top of your newly created JS 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
-
-
-The guide will create all the necessary files for you, using the existing app metadata from iTunes Connect.
+## Start ```snapshot```
 
 - ```cd [your_project_folder]```
 - ```snapshot```
@@ -150,6 +169,12 @@ 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:
 

data/bin/snapshot

@@ -6,6 +6,7 @@ require 'snapshot'
 require 'commander/import'
 require 'snapshot/update_checker'
 require 'snapshot/dependency_checker'
+require 'snapshot/snapfile_creator'
 
 HighLine.track_eof = false
 
@@ -27,8 +28,17 @@ default_command :run
 
 command :run do |c|
   c.syntax = 'snapshot'
-  c.description = 'Run the script, to take all the screenshots.'
+  c.description = 'Run the script, to take all the screenshots'
   c.action do |args, options|
     Snapshot::Runner.new.work
   end
+end
+
+command :init do |c|
+  c.syntax = 'snapshot init'
+  c.description = "Creates a new Snapfile in the current directory"
+
+  c.action do |args, options|
+    Snapshot::SnapfileCreator.create('.')
+  end
 end

data/lib/assets/SnapfileTemplate

@@ -0,0 +1,33 @@
+# Uncommend 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([
+  "iPhone 6",
+  "iPhone 6 Plus",
+  "iPhone 5",
+  "iPhone 4s"
+])
+
+languages([
+  'en-US',
+  'de-DE',
+  'it-IT'
+])
+
+# Where should the resulting screenshots be stored?
+screenshots_path "./screenshots"
+
+# JavaScript UIAutomation file
+# js_file './snapshot.js'
+
+# The name of the project's scheme
+# scheme 'SchemeName'
+
+# Where is your project (or workspace)? Provide the full path here
+# project_path './YourProject.xcworkspace'
+
+# 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'

data/lib/snapshot/page.html.erb

@@ -0,0 +1,55 @@
+<html>
+  <head>
+    <style type="text/css">
+      * {
+        font-family: "HelveticaNeue-Light", "Helvetica Neue Light", "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif; 
+        font-weight: 300;
+      }
+      .language {
+        
+      }
+      .deviceName {
+        padding-top: 20px;
+        font-size: 30px;
+      }
+      .screenshot {
+        cursor: pointer;
+        border: 1px #EEE solid;
+      }
+      td {
+        text-align: center;
+      }
+    </style>
+  </head>
+  <body>
+    <% divide_size_by = 5.0 %>
+    <% max_width = 180 %>
+
+
+    <% @data.each do |language, content| %>
+      <h1 class="language"><%= language %></h1>
+      <hr />
+      <table>
+        <% content.each do |device_name, screens| %>
+          <th colspan="<%= screens.count %>">
+            <h2 class="deviceName">
+              <%= device_name %>
+            </h2>
+          </th>
+          <tr>
+            <% screens.each do |screen_path| %>
+              <td>
+                <% screen_size = FastImage.size(screen_path) %>
+                <a href="<%= screen_path %>" target="_blank">
+                  <img class="screenshot" 
+                         src="<%= screen_path %>",
+                       style="width: <%= [(screen_size[0] / divide_size_by).round, max_width].min %>px;" />
+                </a>
+              </td>
+            <% end %>
+          </tr>
+        <% end %>
+      </table>
+    <% end %>
+  </body>
+</head>

data/lib/snapshot/reports_generator.rb

@@ -0,0 +1,54 @@
+require 'erb'
+require "fastimage"
+
+module Snapshot
+  class ReportsGenerator
+    def generate
+      screens_path = SnapshotConfig.shared_instance.screenshots_path
+
+      @data = {}
+
+      Dir["#{screens_path}/*"].sort.each do |language_path|
+        language = language_path.split('/').last
+        Dir[[language_path, '*'].join('/')].sort.each do |screenshot|
+
+          available_devices.each do |key_name, output_name|
+
+            if screenshot.split('/').last.include?key_name
+              # This screenshot it from this device
+              @data[language] ||= {}
+              @data[language][output_name] ||= []
+              @data[language][output_name] << screenshot
+              break # to not include iPhone 6 and 6 Plus
+            end
+          end
+        end
+      end
+
+      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
+      File.write(export_path, html)
+
+      Helper.log.info "Successfully created HTML file with all the screenshots: #{export_path}".green
+    end
+
+    private
+      def lib_path
+        "./lib/"
+      end
+
+      def available_devices
+        # The order IS important, since those names are used to check for include?
+        # and the iPhone 6 is inlucded in the iPhone 6 Plus
+        {
+          'iPhone6Plus' => "iPhone 6 Plus",
+          'iPhone6' => "iPhone 6",
+          'iPhone5' => "iPhone 5",
+          'iPhone4' => "iPhone 4",
+        }
+      end
+  end
+end

data/lib/snapshot/runner.rb

@@ -13,12 +13,13 @@ module Snapshot
 
       Builder.new.build_app
 
+      counter = 0
       SnapshotConfig.shared_instance.devices.each do |device|
         SnapshotConfig.shared_instance.languages.each do |language|
 
           begin
             run_tests(device, language)
-            copy_screenshots(language)
+            counter += copy_screenshots(language)
           rescue Exception => ex
             Helper.log.error(ex)
           end
@@ -26,8 +27,9 @@ module Snapshot
         end
       end
 
-      Helper.log.info "Successfully finished generating screenshots.".green
+      Helper.log.info "Successfully finished generating #{counter} screenshots.".green
       Helper.log.info "Check it out here: #{SnapshotConfig.shared_instance.screenshots_path}".green
+      ReportsGenerator.new.generate
     end
 
     def clean_old_traces
@@ -85,13 +87,13 @@ module Snapshot
 
     def copy_screenshots(language)
       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
+      return Dir.glob("#{TRACE_DIR}/**/*.png").count
     end
 
     def generate_test_command(device, language, app_path)

data/lib/snapshot/snapfile_creator.rb

@@ -0,0 +1,24 @@
+module Snapshot
+  class SnapfileCreator
+    # This method will take care of creating a Snapfile
+    def self.create(path)
+      path = [path, 'Snapfile'].join("/")
+
+      raise "Snapfile already exists at path '#{path}'. Run 'snapshot' to use Snapshot.".red if File.exists?(path)
+
+      template = File.read("#{gem_path}/lib/assets/SnapfileTemplate")
+      File.write(path, template)
+
+      puts "Successfully created new Snapfile at '#{path}'".green
+    end
+
+     private
+      def self.gem_path
+        if not Helper.is_test? and Gem::Specification::find_all_by_name('snapshot').any?
+          return Gem::Specification.find_by_name('snapshot').gem_dir
+        else
+          return './'
+        end
+      end
+  end
+end

data/lib/snapshot/snapshot_config.rb

@@ -25,6 +25,9 @@ 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
+
 
     # A shared singleton
     def self.shared_instance
@@ -61,6 +64,8 @@ module Snapshot
 
       self.project_path = (Dir.glob("./*.xcworkspace").first rescue nil)
       self.project_path ||= (Dir.glob("./*.xcodeproj").first rescue nil)
+
+      self.html_path = './screenshots.html'
     end
 
     # Getters
@@ -72,11 +77,13 @@ module Snapshot
 
     # The JavaScript UIAutomation file
     def js_file
+      return manual_js_file if manual_js_file
+
       files = Dir.glob("./*.js").delete_if { |path| path.include?"SnapshotHelper.js" }
       if files.count == 1
         return files.first
       else
-        raise "Could not determine which UIAutomation file to use. Please pass a path to your Javascript file using 'js_path'.".red
+        raise "Could not determine which UIAutomation file to use. Please pass a path to your Javascript file using 'js_file'.".red
       end
     end
 

data/lib/snapshot/snapshot_file.rb

@@ -32,15 +32,19 @@ 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
+          @config.manual_js_file = value.gsub("~", ENV['HOME'])
         when :screenshots_path
           raise "screenshots_path has to be an String".red unless value.kind_of?String
-          @config.screenshots_path = value
+          @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"
         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
+            @config.project_path = value.gsub("~", ENV['HOME'])
           else
             raise "The given project_path '#{value}' could not be found. Make sure to include the extension as well.".red
           end

data/lib/snapshot/version.rb

@@ -1,3 +1,3 @@
 module Snapshot
-  VERSION = "0.1.0"
+  VERSION = "0.2.1.beta1"
 end

data/lib/snapshot.rb

@@ -6,6 +6,7 @@ require 'snapshot/runner'
 require 'snapshot/builder'
 require 'snapshot/snapshot_file'
 require 'snapshot/languages'
+require 'snapshot/reports_generator'
 
 # Third Party code
 require 'colored'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1.beta1
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2014-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.21
 - !ruby/object:Gem::Dependency
-  name: plist
+  name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: colored
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: commander
+  name: fastimage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 1.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 1.6.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -175,12 +175,16 @@ files:
 - LICENSE
 - README.md
 - bin/snapshot
+- lib/assets/SnapfileTemplate
 - lib/snapshot.rb
 - lib/snapshot/builder.rb
 - lib/snapshot/dependency_checker.rb
 - lib/snapshot/helper.rb
 - lib/snapshot/languages.rb
+- lib/snapshot/page.html.erb
+- lib/snapshot/reports_generator.rb
 - lib/snapshot/runner.rb
+- lib/snapshot/snapfile_creator.rb
 - lib/snapshot/snapshot_config.rb
 - lib/snapshot/snapshot_file.rb
 - lib/snapshot/update_checker.rb
@@ -189,8 +193,7 @@ homepage: http://felixkrause.at
 licenses:
 - MIT
 metadata: {}
-post_install_message: This gem requires phantomjs. Install it using 'brew update &&
-  brew install phantomjs'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -198,12 +201,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2