motion-launchimages 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a011eb95f543bac37beccf3bf70cf10c5668df0
-  data.tar.gz: efabfc1d2b75fd98d9535021240052d2cd89ca24
+  metadata.gz: 18fd80f96feb03a295a41dccf527d33c515c44d8
+  data.tar.gz: 8113afad181ea88a96c9c56357867ca919599425
 SHA512:
-  metadata.gz: f571a451be42262a1bb6319095b20d958fab480965caa97fa41e909be84780d1f1573e3acb234cfe9fe0d5f4f14d6adf9c5b02db02bc0ab4743cb0ea7c3e3f4a
-  data.tar.gz: dbc5e4804244f82e52afad693b8a738d67d363c4bd878fcd79a65590feca913b155de8befc2ea12eacd6bd84d4550274192e46c9760c53eab7bdd7d14dddaabf
+  metadata.gz: 56f30c0af3314fbd3e5fb96f1fd8637a91e4cbbf0d0bf118a97f22c4f01a0bcc4e57ca12bedf54eae43d264cccb562fd4cdca6a2eb750661467b924533868e77
+  data.tar.gz: 52833c69cb4fdf6cbd378e6ad1a5396ab769b87a8ed8ac7fa72efd0be5593124460891b05bdcf0f05a843fe53258753af2cf1be6c76041711aa16dc4197473d9

data/README.md

@@ -43,10 +43,10 @@ end
 
 ## Running
 
-Just run `rake launchimages`! The task will launch your app in the simulator several times with different screen sizes and save the screenshots in your resources directory with the correct names. It detects whether it's being run on an iPhone or iPad (or both) app and only takes the screenshots it needs to.
+Just run `rake launchimages`. The task will launch your app in the simulator several times with different screen sizes and save the screenshots in your resources directory with the correct names. It detects whether it's being run on an iPhone or iPad (or both) app and only takes the screenshots it needs to.
 
-If you want to just take the screenshot at one resolution, you can run `rake take_launchimages=true device_name="iPhone 6 Plus"` (for example). Any of the iPhone or iPad devices should work. You can get a full list of what's available by opening the simulator, going to the `Hardware` menu and looking under `Device`.
+If you want to just take the screenshot for one device, you can run `rake take_launchimages=true device_name="iPhone 8 Plus"` (for example). See [devices.rb](lib/motion/devices.rb) for a list of acceptable values for `device_name`.
 
-## Contact
+### Hybrid Apps
 
-[Brendan J. Caffrey](http://brendan.jcaffrey.com/)
+If you have a hybrid app (iPhone and iPad), you may want to split up the launch image generation into two steps by running `rake launchimages type="ipad"`, closing all open simulators when it's done, then `rake launchimages type="iphone"` after. There seems to be some sort of limit on the number of simulators that can be open at once, and the `rake` command hangs when the limit is hit.

data/lib/motion-launchimages.rb

@@ -1,36 +1,72 @@
 require 'open3'
+require_relative 'motion/devices.rb'
 
 unless defined?(Motion::Project::Config)
   raise 'This file must be required within a RubyMotion project Rakefile.'
 end
 
+def get_screenshot_path
+  Dir.pwd + '/resources/'
+end
+
 Motion::Project::App.setup do |app|
   Dir.glob(File.join(File.dirname(__FILE__), 'motion/*.rb')).each do |file|
     app.files.unshift(file)
 
     if ENV.has_key?('take_launchimages')
-      app.info_plist['screenshot_path'] = Dir.pwd + '/resources/'
+      app.info_plist['screenshot_path'] = get_screenshot_path
+
+      if !ENV.has_key?('device_name')
+        puts "The device_name environment key must be specified to motion-launchimages to run"
+        exit
+      end
+      app.info_plist['device_name'] = ENV['device_name']
+
+      # this is done both in the `rake launchimages` process and the `rake` process because this can be ran directly
+      # and errors don't propogate up to the parent process (which is something that should probably be fixed)
+      Motion::LaunchImages.get_device(ENV['device_name']).check_screenshots_exists
+    end
+  end
+end
+
+class Device
+  def filepath(orientation)
+    "#{get_screenshot_path}#{filename(orientation)}"
+  end
+
+  def check_screenshots_exists
+    check_screenshot_exists(:portrait)
+    check_screenshot_exists(:landscape) if landscape
+  end
+
+  private
+
+  def check_screenshot_exists(orientation)
+    if !File.exists?(filepath(orientation))
+      puts "Error: Please make sure #{filepath(orientation)} exists before running. The app will not launch with the correct screensize otherwise."
+      puts "You should be able to download an example one at https://github.com/brendanjcaffrey/motion-launchimages/tree/master/sample/resources/#{filename(orientation)}"
+      exit
     end
   end
 end
 
 desc 'Take launch images of your app at all display resolutions'
 task :launchimages do
-  devices = []
   family = Motion::Project::App.config.device_family
   family = [family] if family.is_a?(Symbol)
 
-  if family.index(:iphone) != nil
-    devices << 'iPhone 4s' << 'iPhone 5s' << 'iPhone 6' << 'iPhone 6 Plus'
-  end
+  family -= [:iphone] if ENV['type'].to_s.downcase == 'ipad'
+  family -= [:ipad]   if ENV['type'].to_s.downcase == 'iphone'
 
-  if family.index(:ipad) != nil
-    devices << 'iPad 2' << 'iPad Air'
-  end
+  devices = {}
+  devices.merge!(Motion::LaunchImages.iphones) if family.index(:iphone) != nil
+  devices.merge!(Motion::LaunchImages.ipads)   if family.index(:ipad)   != nil
+
+  devices.each do |device_name, device_specs|
+    device_specs.check_screenshots_exists
 
-  devices.each do |device|
-    puts "Taking screenshot on #{device}"
-    Open3.popen3({'take_launchimages' => 'true', 'device_name' => device}, 'rake') do |i, o, e, s|
+    puts "Taking screenshot on #{device_name}"
+    Open3.popen3({'take_launchimages' => 'true', 'device_name' => device_name}, 'rake') do |i, o, e, s|
       o.read
     end
   end

data/lib/motion/devices.rb

@@ -0,0 +1,66 @@
+module Motion
+  Device = Struct.new(:width, :height, :scale, :landscape, :no_height_label) do
+    def filename(orientation)
+      if orientation == :portrait
+        size_measurement = height/scale
+        orientation_label = landscape ? '-Portrait' : ''
+      elsif orientation == :landscape
+        size_measurement = width/scale
+        orientation_label = '-Landscape'
+      end
+      size_label = no_height_label ? '' : "-#{size_measurement}h"
+
+      "Default#{orientation_label}#{size_label}@#{scale}x.png"
+    end
+
+    def filepath(orientation)
+      "#{get_screenshot_path}#{filename(orientation)}"
+    end
+
+    def check_screenshots_exists
+      check_screenshot_exists(:portrait)
+      check_screenshot_exists(:landscape) if landscape
+    end
+
+    private
+
+    def check_screenshot_exists(orientation)
+      if !File.exists?(filepath(orientation))
+        puts "Error: Please make sure #{filepath(orientation)} exists before running. The app will not launch with the correct screensize otherwise."
+        puts "You should be able to download an example one at https://github.com/brendanjcaffrey/motion-launchimages/tree/master/sample/resources/#{filename(orientation)}"
+        exit
+      end
+    end
+  end
+
+  class LaunchImages
+    def self.iphones
+      {
+        'iPhone SE'     => Device.new(640,  1136, 2, false, false), # also iPhone 5s
+        'iPhone 8'      => Device.new(750,  1334, 2, false, false), # also iPhone 6/7
+        'iPhone 8 Plus' => Device.new(1242, 2208, 3, false, false), # also iPhone 6/7 Plus
+        'iPhone X'      => Device.new(1125, 2436, 3, false, false),
+      }
+    end
+
+    def self.ipads
+      {
+        'iPad Pro (9.7-inch)'  => Device.new(1536, 2048, 2, true, true),
+        'iPad Pro (10.5-inch)' => Device.new(1668, 2224, 2, true, false),
+        'iPad Pro (12.9-inch)' => Device.new(2048, 2732, 2, true, false),
+      }
+    end
+
+    def self.get_device(name)
+      if iphones.has_key?(name)
+        iphones[name]
+      elsif ipads.has_key?(name)
+        ipads[name]
+      else
+        puts "Unable to find device #{name}"
+        exit
+      end
+    end
+  end
+end
+

data/lib/motion/launch_images.rb

@@ -4,6 +4,10 @@ module Motion
       NSBundle.mainBundle.objectForInfoDictionaryKey('screenshot_path')
     end
 
+    def self.device_name
+      NSBundle.mainBundle.objectForInfoDictionaryKey('device_name')
+    end
+
     def self.taking?
       screenshot_path != nil
     end
@@ -17,35 +21,30 @@ module Motion
           sleep 1.0
         end
 
-        Dispatch::Queue.main.async { capture! }
+        Dispatch::Queue.main.async { capture!(orientation) }
       end
     end
 
-    def self.capture!
+    def self.capture!(orientation)
+      # sanity check the device values
       screen = UIScreen.mainScreen
-      height = screen.bounds.size.height
-      scale = begin
-        if !screen.respondsToSelector('displayLinkWithTarget:selector:')
-          ''
-        elsif screen.scale == 1.0
-          ''
-        elsif screen.scale == 2.0
-          '@2x'
-        elsif screen.scale == 3.0
-          '@3x'
-        else
-          puts 'Error: Unable to determine screen scale'
-          exit
-        end
+      height = screen.bounds.size.height.to_i
+      scale = screen.respondsToSelector('displayLinkWithTarget:selector:') ? screen.scale.to_i : 1
+      device = get_device(device_name)
+      expected_height = (orientation == :portrait ? device.height : device.width) / device.scale
+
+      if expected_height != height || device.scale != scale
+        puts "In #{orientation.to_s}, height was expected to be #{expected_height} but was #{height} and/or scale was expected to be #{device.scale} but was #{scale}"
+        exit
       end
-      filename = generate_filename(height, scale)
 
-      if scale != ''
+      if scale > 1
         UIGraphicsBeginImageContextWithOptions(window.bounds.size, false, screen.scale)
-      else
+      else # TODO not sure if this is necessary anymore?
         UIGraphicsBeginImageContext(window.bounds.size)
       end
 
+      filename = screenshot_path + device.filename(orientation)
       window.layer.renderInContext(UIGraphicsGetCurrentContext())
       image = UIGraphicsGetImageFromCurrentImageContext()
       UIGraphicsEndImageContext()
@@ -53,36 +52,13 @@ module Motion
       data.writeToFile(filename, atomically:true)
       puts "Wrote to #{filename}"
 
-      if should_rotate_and_take_again?(height)
+      if orientation == :portrait && device.landscape
         take!(:landscape)
       else
         exit
       end
     end
 
-    def self.generate_filename(height, scale)
-      filename = screenshot_path + 'Default'
-
-      case height
-      when 480 # iPhone 4s
-      when 568 # iPhone 5s
-        filename << '-568h'
-      when 667 # iPhone 6
-        filename << '-667h'
-      when 736 # iPhone 6 Plus
-        filename << '-736h'
-      when 768 # iPad (Landscape)
-        filename << '-Landscape'
-      when 1024 # iPad (Portrait)
-        filename << '-Portrait'
-      else
-        puts "Error: Invalid screen height #{height}"
-        exit
-      end
-
-      filename << scale << '.png'
-    end
-
     # ported from BubbleWrap to reduce dependencies
     def self.window
       normal_windows = UIApplication.sharedApplication.windows.select { |w|
@@ -96,10 +72,6 @@ module Motion
       key_window || normal_windows.first
     end
 
-    def self.should_rotate_and_take_again?(height)
-      height == 1024 # iPad (Portrait)
-    end
-
     def self.rotate(to)
       if to == :portrait
         value = NSNumber.numberWithInt(UIInterfaceOrientationPortrait)

data/motion-launchimages.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'motion-launchimages'
-  s.version     = '1.0.0'
+  s.version     = '1.1.0'
   s.summary     = 'Automate RubyMotion launch images'
   s.description = 'Automate RubyMotion launch images'
   s.homepage    = 'https://github.com/brendanjcaffrey/motion-launchimages'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion-launchimages
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brendan J. Caffrey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2017-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/motion-launchimages.rb
+- lib/motion/devices.rb
 - lib/motion/launch_images.rb
 - motion-launchimages.gemspec
 homepage: https://github.com/brendanjcaffrey/motion-launchimages
@@ -55,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Automate RubyMotion launch images