snapshot 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54a6a5e5c88121d5cd4642db73d3d91abda68652
-  data.tar.gz: eb8ccdeacbc9fe7e28eba1303ae893bfd7aa5b15
+  metadata.gz: 920d554867f6ee77a1100ff2c43f43065a9356ea
+  data.tar.gz: 19834058363057e3e1f3ceb68412079c065878ae
 SHA512:
-  metadata.gz: cc159b6a65bc09699e93ce6d6e2c07fd0e9f27a226475731c5baa9f42b77488046bc9216ad47447a2fb0e9f8916b8890475d07e7429e820df3ceeda15c72e262
-  data.tar.gz: 7cf3a8180e30074137ce70c01bcbe022cd5513eabce15a1cd9711206b51b147de2025244bc7b84f0924beb5f916fdfa701097b53a27e6b1e995f9497578b2047
+  metadata.gz: eecfdc2cbf3fb17854217c78b740616cce1f30314c1624f5eb480e792472f93ac8c6df92e5804972caa359bd82f888a7ebc19188cd6b6bceb40da532f8d52696
+  data.tar.gz: 246ff86c93511de42fcda6a8c5f6b6fc162dbbc625f2cbfa6becf3128ec509ae4b4bdb6234831107d2fe9e40e615373b4d04de82ff01c91d14973cec7093461b

data/README.md

@@ -233,18 +233,19 @@ ios_version "9.0"
 
 ### Custom Args for the build command
 Use the ```custom_args``` directive to prepend custom statements to the build command.
-```ruby
-custom_args "GCC_PREPROCESSOR_DEFINITIONS='SCREENSHOTS'"
-```
+
 Add a ```custom_build_args``` line to your ```Snapfile``` to add custom arguments to the build command.
+
+Here is an example for adding a preprocessor macro `SNAPSHOT` and  a custom build setting `SNAPSHOT_ENABLE`.
+
 ```ruby
-custom_build_args "-configuration release"
+custom_build_args "GCC_PREPROCESSOR_DEFINITIONS='$(inherited) SNAPSHOT=1' SNAPSHOT_ENABLE = YES"
 ```
 
 ### Custom Build Command
 If for some reason, the default build command does not work for your project, you can pass your own build script. The script will be executed **once** before the tests are being run.
 
-**Make sure** you are setting the output path to ```/tmp/snapshot```.
+**Make sure** you are setting the output path to ```/tmp/snapshot``` or specify a custom ```build_dir``` on your ```Snapfile```.
 
 ```ruby
 build_command "xcodebuild DSTROOT='/tmp/snapshot' OBJROOT='/tmp/snapshot' SYMROOT='/tmp/snapshot' ... "
@@ -349,6 +350,33 @@ Unfortunately ```Instruments``` sometimes decides, to not respond to anything. W
 
 The only way to fix this, is a restart of the Mac. 
 
+## Use a custom build system
+Using a build systems not based on Xcode –such as RubyMotion or Xamarin– is also possible.
+
+### RubyMotion
+
+Add to your ```Snapfile```:
+
+```ruby
+build_dir 'build/iPhoneSimulator-7.0-Development'
+build_command 'rake build:simulator'
+```
+
+### Xamarin
+
+Add to your ```Snapfile```:
+
+```ruby
+build_dir 'YourProject/bin/iPhoneSimulator'
+build_command '/Applications/Xamarin\ Studio.app/Contents/MacOS/mdtool -v build "--configuration:Debug|iPhoneSimulator" YourProject.sln'
+```
+
+Unfortunately, Xamarin command line tool is only available for Business Edition licenses. For Indie licenses you can build the app using Xamarin Studio and use the ```--nobuild``` option.
+
+### Skip building
+
+If building via command-line doesn't work for your project or you don't want to build every time, you can run the tool with ```snapshot --nobuild``` to skip the build process and use a pre-built ```.app``` under your ```build_dir```.
+
 # Need help?
 - If there is a technical problem with ```snapshot```, submit an issue.
 - I'm available for contract work - drop me an email: snapshot@krausefx.com

data/bin/snapshot

@@ -22,6 +22,7 @@ class SnapshotApplication
     program :help_formatter, :compact
 
     global_option '--snapfile PATH', String, 'Custom path for your Snapfile.'
+    global_option '--nobuild', 'Skips the build process when running snapshot.'
     global_option '--noclean', 'Skips the clean process of the build command when running snapshot.'
     global_option('--verbose', 'Shows all output printed by Instruments.') { $verbose = true }
 
@@ -36,7 +37,7 @@ class SnapshotApplication
         Dir.chdir(path) do # switch the context
           Snapshot::DependencyChecker.check_simulators
           Snapshot::SnapshotConfig.shared_instance(options.snapfile)
-          Snapshot::Runner.new.work(clean: !options.noclean)
+          Snapshot::Runner.new.work(clean: !options.noclean, build: !options.nobuild)
         end
       end
     end

data/lib/snapshot/builder.rb

@@ -1,14 +1,12 @@
 module Snapshot
   class Builder
-    BUILD_DIR = '/tmp/snapshot'
-
 
     def initialize
-      
+      @build_dir = SnapshotConfig.shared_instance.build_dir || '/tmp/snapshot'
     end
 
     def build_app(clean: true)
-      FileUtils.rm_rf(BUILD_DIR) if clean
+      FileUtils.rm_rf(@build_dir) if clean
 
       command = SnapshotConfig.shared_instance.build_command
 
@@ -33,14 +31,17 @@ module Snapshot
             raise ex
           end
         end
+        Process.wait(pid)
       end
+      # Exit status for build command, should be 0 if build succeeded
+      cmdstatus = $?.exitstatus
 
-      if all_lines.join('\n').include?'** BUILD SUCCEEDED **'
+      if cmdstatus == 0 || all_lines.join('\n').include?('** BUILD SUCCEEDED **')
         Helper.log.info "BUILD SUCCEEDED".green
         return true
       else
         Helper.log.info(all_lines.join(' '))
-        raise "Looks like the build was not successfull."
+        raise "Looks like the build was not successful."
       end
     end
 
@@ -70,12 +71,12 @@ module Snapshot
         [
           build_command,
           "-sdk iphonesimulator",
-          "CONFIGURATION_BUILD_DIR='#{BUILD_DIR}/build'",
+          "CONFIGURATION_BUILD_DIR='#{@build_dir}/build'",
           "-#{proj_key} '#{proj_path}'",
           "-scheme '#{scheme}'",
-          "DSTROOT='#{BUILD_DIR}'",
-          "OBJROOT='#{BUILD_DIR}'",
-          "SYMROOT='#{BUILD_DIR}'",
+          "DSTROOT='#{@build_dir}'",
+          "OBJROOT='#{@build_dir}'",
+          "SYMROOT='#{@build_dir}'",
           custom_build_args,
           actions.join(' ')
         ].join(' ')

data/lib/snapshot/page.html.erb

@@ -22,6 +22,9 @@
         border: 1px #EEE solid;
         z-index: 0;
       }
+      th {
+        text-align: left;
+      }
       td {
         text-align: center;
       }

data/lib/snapshot/reports_generator.rb

@@ -12,16 +12,18 @@ module Snapshot
         language = File.basename(language_path)
         Dir[File.join(language_path, '*')].sort.each do |screenshot|
 
-          available_devices.each do |key_name, output_name|
+          ["portrait", "landscape"].each do |orientation|
+            available_devices.each do |key_name, output_name|
+              if File.basename(screenshot).include?key_name and File.basename(screenshot).include?orientation
+                output_name += " (#{orientation.capitalize})"
+                # This screenshot it from this device
+                @data[language] ||= {}
+                @data[language][output_name] ||= []
 
-            if File.basename(screenshot).include?key_name
-              # This screenshot it from this device
-              @data[language] ||= {}
-              @data[language][output_name] ||= []
-
-              resulting_path = File.join('.', language, File.basename(screenshot))
-              @data[language][output_name] << resulting_path
-              break # to not include iPhone 6 and 6 Plus (name is contained in the other name)
+                resulting_path = File.join('.', language, File.basename(screenshot))
+                @data[language][output_name] << resulting_path
+                break # to not include iPhone 6 and 6 Plus (name is contained in the other name)
+              end
             end
           end
         end

data/lib/snapshot/runner.rb

@@ -5,10 +5,10 @@ module Snapshot
   class Runner
     TRACE_DIR = '/tmp/snapshot_traces'
 
-    def work(clean: true)
+    def work(clean: true, build: true)
       SnapshotConfig.shared_instance.js_file # to verify the file can be found earlier
 
-      Builder.new.build_app(clean: clean)
+      Builder.new.build_app(clean: clean) if build
       @app_path = determine_app_path
 
       counter = 0
@@ -153,7 +153,8 @@ module Snapshot
 
     def determine_app_path
       # Determine the path to the actual app and not the WatchKit app
-      Dir.glob("/tmp/snapshot/build/*.app/*.plist").each do |path|
+      build_dir = SnapshotConfig.shared_instance.build_dir || '/tmp/snapshot'
+      Dir.glob("#{build_dir}/**/*.app/*.plist").each do |path|
         watchkit_enabled = `/usr/libexec/PlistBuddy -c 'Print WKWatchKitApp' '#{path}'`.strip
         next if watchkit_enabled == 'true' # we don't care about WatchKit Apps
 

data/lib/snapshot/snapshot_config.rb

@@ -25,9 +25,12 @@ module Snapshot
     # @return (String) The path, in which the screenshots should be stored
     attr_accessor :screenshots_path
 
-    # @return (String) The build command, wich should build the app to '/tmp/snapshot'
+    # @return (String) The build command, wich should build the app to build_dir (/tmp/snapshot by default)
     attr_accessor :build_command
 
+    # @return (String) The build directory, defaults to '/tmp/snapshot'
+    attr_accessor :build_dir
+
     # @return (BOOL) Skip the removal of the alpha channel from the screenshots
     attr_accessor :skip_alpha_removal
 
@@ -138,7 +141,7 @@ module Snapshot
 
     # Returns the file name of the project
     def project_name
-      File.basename(self.project_path, ".*" )
+      File.basename(self.project_path, ".*" ) if self.project_path
     end
 
     # The JavaScript UIAutomation file

data/lib/snapshot/snapshot_file.rb

@@ -44,6 +44,9 @@ module Snapshot
         when :build_command
           raise "build_command has to be an String".red unless value.kind_of?String
           @config.build_command = value
+        when :build_dir
+          raise "build_dir has to be an String".red unless value.kind_of?String
+          @config.build_dir = File.expand_path(value)
         when :custom_args
           raise "custom_args has to be an String".red unless value.kind_of?String
           @config.custom_args = value

data/lib/snapshot/version.rb

@@ -1,3 +1,3 @@
 module Snapshot
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastimage
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement