snapshot 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fb8551c6c185df8ccba72657f78aed84d5970fc
-  data.tar.gz: 80bac1bdfc3f0d1f0a682267f781a32416b7a94a
+  metadata.gz: 61213c3f96c8204607fbf018d40e57c4c4499a7a
+  data.tar.gz: 82488176f7d6e23c45392d2fd424da1929605ee3
 SHA512:
-  metadata.gz: bab34e72bc1436f0d5ff95e0acfa78518b87101d9ceed42308233741539de56aa01a0f93614772400ed3d88344ffb7f62ad5cc42ab98e4916eeb892cf66c4215
-  data.tar.gz: 53ee98138bc60617066898664f37f26a5a252c7ffc635ec826fa54d177249944e4509372a2e7d6e02fcc250ea7d9a8440dbeb9274a77f6996596c22b2c9203c3
+  metadata.gz: f02b63a85ef1840d80ca11f0498aae358e6b94b86d5df05a2800b293dda4f38124388a203343ef3f523b4dfc608847da547b8a0a1437baae559319e1f8d2b084
+  data.tar.gz: c5ecae81b1c0f848b3605436b95e58718b74e5b23798aad679feafa99d832f393fffecd4b9a0518c3cb5635235acd5a8a31077464bb1825b6c1ef1f010d1e680

data/README.md

@@ -167,12 +167,14 @@ To not be asked which scheme to use, just set it like this:
 ```ruby
 scheme "Name"
 ```
+You can also use the environment variable ```SNAPSHOT_SCHEME```.
 
 ### Screenshots output path
 All generated screenshots will be stored in the given path.
 ```ruby
 screenshots_path './screenshots'
 ```
+You can also use the environment variable ```SNAPSHOT_SCREENSHOTS_PATH```.
 
 ### Project Path
 By default, ```snapshot``` will look for your project in the current directory. If it is located somewhere else, pass your custom path:
@@ -198,6 +200,37 @@ If for some reason, the default build command does not work for your project, yo
 
 **Make sure** you are setting the output path to ```/tmp/snapshot```.
 
+```ruby
+build_command "xcodebuild DSTROOT='/tmp/snapshot' OBJROOT='/tmp/snapshot' SYMROOT='/tmp/snapshot' ... "
+```
+
+### Custom callbacks to prepare your app
+Run your own script when ```snapshot``` switches the simulator type or the language. 
+This can be used to 
+- Logout the user
+- Reset all user defaults
+- Pre-fill the database
+
+To run a shell script, just use ```system('./script.sh')```.
+```ruby
+setup_for_device_change do |device| 
+  puts "Preparing device: #{device}"
+end
+
+setup_for_language_change do |lang, device|
+  puts "Running #{lang} on #{device}"
+  system("./popuplateDatabase.sh")
+end
+
+teardown_language do |lang, device|
+  puts "Finished with #{lang} on #{device}"
+end
+
+teardown_device do |device|
+  puts "Cleaning device #{device}"
+  system("./cleanup.sh")
+end
+```
 
 # Tips
 ## Available language codes

data/lib/assets/SnapfileTemplate

@@ -30,4 +30,25 @@ screenshots_path "./screenshots"
 # ios_version '8.1'
 
 # The path, on which the HTML file should be exported to
-# html_path './screenshots.html'
+# html_path './screenshots.html'
+
+
+# Custom Callbacks
+
+# setup_for_device_change do |device| 
+#   puts "Preparing device: #{device}"
+# end
+
+# setup_for_language_change do |lang, device|
+#   puts "Running #{lang} on #{device}"
+#   system("./popuplateDatabase.sh")
+# end
+
+# teardown_language do |lang, device|
+#   puts "Finished with #{lang} on #{device}"
+# end
+
+# teardown_device do |device|
+#   puts "Cleaning device #{device}"
+#   system("./cleanup.sh")
+# end

data/lib/assets/SnapshotHelper.js

@@ -1,10 +1,14 @@
 function wait_for_loading_indicator_to_be_finished()
 {
   re = UIATarget.localTarget().frontMostApp().statusBar().elements()[2].rect()
-  while (re['size']['width'] == 10 && re['size']['height'] == 20) {
+  re2 = UIATarget.localTarget().frontMostApp().statusBar().elements()[3].rect()
+  while ((re['size']['width'] == 10 && re['size']['height'] == 20) ||
+         (re2['size']['width'] == 10 && re2['size']['height'] == 20))
+   {
     UIALogger.logMessage("Loading indicator is visible... waiting")
     UIATarget.localTarget().delay(1)
     re = UIATarget.localTarget().frontMostApp().statusBar().elements()[2].rect()
+    re2 = UIATarget.localTarget().frontMostApp().statusBar().elements()[3].rect()
   }
 }
 
@@ -14,14 +18,16 @@ function captureLocalizedScreenshot(name) {
   var target = UIATarget.localTarget();
   var model = target.model();
   var rect = target.rect();
+  
+  var theSize = (rect.size.width > rect.size.height) ? rect.size.width.toFixed() : rect.size.height.toFixed();
 
   if (model.match(/iPhone/)) 
   {
-    if (rect.size.height > 667) {
+    if (theSize > 667) {
       model = "iPhone6Plus";
-    } else if (rect.size.height == 667) {
+    } else if (theSize == 667) {
       model = "iPhone6";
-    } else if (rect.size.height == 568){
+    } else if (theSize == 568){
       model = "iPhone5";
     } else {
     model = "iPhone4";
@@ -40,4 +46,4 @@ function captureLocalizedScreenshot(name) {
 
   var parts = [language, model, orientation, name];
   target.captureScreenWithName(parts.join("-"));
-}
+}

data/lib/snapshot/dependency_checker.rb

@@ -4,6 +4,7 @@ module Snapshot
       self.check_xcode_select
       self.check_simulators
       self.check_xctool
+      self.check_for_automation_subfolder
     end
 
     def self.check_xcode_select
@@ -41,5 +42,11 @@ module Snapshot
         Helper.log.error '#############################################################'
       end
     end
+
+    def self.check_for_automation_subfolder
+      if File.directory?"./Automation" or File.exists?"./Automation"
+        raise "Seems like you have an 'Automation' folder in the current directory. You need to delete/rename it!".red
+      end
+    end
   end
 end

data/lib/snapshot/runner.rb

@@ -16,16 +16,23 @@ module Snapshot
       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|
+          SnapshotConfig.shared_instance.blocks[:setup_for_language_change].call(language, device) # Callback
 
           begin
             errors.concat(run_tests(device, language))
             counter += copy_screenshots(language)
-          rescue Exception => ex
+          rescue SystemExit, Interrupt => ex
+            raise ex # system interrupted exception (Strg + C)
+          rescue StandardError => ex
             Helper.log.error(ex)
           end
-
+          SnapshotConfig.shared_instance.blocks[:teardown_language].call(language, device) # Callback
         end
+        SnapshotConfig.shared_instance.blocks[:teardown_device].call(device) # Callback
       end
 
       ReportsGenerator.new.generate

data/lib/snapshot/screenshot_flatten.rb

@@ -3,6 +3,7 @@ module Snapshot
   class ScreenshotFlatten
     # @param (String) The path in which the screenshots are located in
     def run(path)
+      Helper.log.info "Going to remove the alpha channel from generated png files"
       if image_magick_installed?
         flatten(path)
       else
@@ -13,9 +14,11 @@ module Snapshot
     end
 
     def flatten(path)
-      Dir.glob([path, '**/*.png'].join('/')).each do |file|
+      Dir.glob([path, '/**/*.png'].join('/')).each do |file|
+        Helper.log.info "Removing alpha channel from '#{file}'"
         `convert -flatten '#{file}' -alpha off -alpha remove '#{file}'`
       end
+      Helper.log.info "Finished removing the alpha channel."
     end
 
     def image_magick_installed?

data/lib/snapshot/snapshot_config.rb

@@ -31,6 +31,9 @@ module Snapshot
     # @return (String) The build command, wich should build the app to '/tmp/snapshot'
     attr_accessor :build_command
 
+    # @return (Hash) All the blocks, which are called on specific actions
+    attr_accessor :blocks
+
 
     # A shared singleton
     def self.shared_instance
@@ -46,6 +49,8 @@ module Snapshot
       else
         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."
       end
+
+      load_env
     end
 
     def set_defaults
@@ -69,6 +74,20 @@ module Snapshot
       self.project_path ||= (Dir.glob("./*.xcodeproj").first rescue nil)
 
       self.html_path = './screenshots.html'
+
+      empty = Proc.new {}
+      self.blocks = {
+        setup_for_device_change: empty, 
+        teardown_device: empty,
+        setup_for_language_change: empty,
+        teardown_language: empty
+      }
+    end
+
+    def load_env
+      # Load environment variables
+      self.manual_scheme = ENV["SNAPSHOT_SCHEME"] if ENV["SNAPSHOT_SCHEME"]
+      self.screenshots_path = ENV["SNAPSHOT_SCREENSHOTS_PATH"] if ENV["SNAPSHOT_SCREENSHOTS_PATH"]
     end
 
     # Getters

data/lib/snapshot/snapshot_file.rb

@@ -16,7 +16,11 @@ module Snapshot
     end
 
     def method_missing(method_sym, *arguments, &block)
-      value = arguments.first || (block.call if block_given?)
+      if ["setup", "teardown"].any?{|a| method_sym.to_s.include?a }
+        value = nil # this is a block
+      else
+        value = arguments.first || (block.call if block_given?) # this is either a block or a value
+      end
 
       case method_sym
         when :devices
@@ -51,6 +55,11 @@ module Snapshot
           else
             raise "The given project_path '#{value}' could not be found. Make sure to include the extension as well.".red
           end
+
+        # 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?
+          @config.blocks[method_sym] = block
         else
           Helper.log.error "Unknown method #{method_sym}"
         end

data/lib/snapshot/version.rb

@@ -1,3 +1,3 @@
 module Snapshot
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.21
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.21
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: fastimage
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7.4
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Take the pain out of taking iOS app screenshots.
@@ -202,12 +202,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []