Class: Deliver::AppScreenshot

Inherits:
Object
  • Object
show all
Defined in:
lib/deliver/app_screenshot.rb

Overview

AppScreenshot represents one screenshots for one specific locale and device type.

Defined Under Namespace

Modules: ScreenSize

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, language, screen_size = nil) ⇒ AppScreenshot

Returns a new instance of AppScreenshot.

Parameters:

  • path (String) —

    path to the screenshot file

  • path (String) —

    Language of this screenshot (e.g. English)

  • screen_size (Deliver::AppScreenshot::ScreenSize) (defaults to: nil) —

    the screen size, which will automatically be calculated when you don’t set it.



50
51
52
53
54
55
56
57
58
 
# File 'lib/deliver/app_screenshot.rb', line 50

def initialize(path, language, screen_size = nil)
  self.path = path
  self.language = language
  screen_size ||= self.class.calculate_screen_size(path)

  self.screen_size = screen_size

  UI.error("Looks like the screenshot given (#{path}) does not match the requirements of #{screen_size}") unless self.is_valid?
end

Instance Attribute Details

#language ⇒ Object

Returns the value of attribute language.



44
45
46
 
# File 'lib/deliver/app_screenshot.rb', line 44

def language
  @language
end

#path ⇒ Object

Returns the value of attribute path.



42
43
44
 
# File 'lib/deliver/app_screenshot.rb', line 42

def path
  @path
end

#screen_size ⇒ Deliver::ScreenSize

Returns the screen size (device type) specified at ScreenSize.

Returns:



40
41
42
 
# File 'lib/deliver/app_screenshot.rb', line 40

def screen_size
  @screen_size
end

Class Method Details

.calculate_screen_size(path) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/deliver/app_screenshot.rb', line 192

def self.calculate_screen_size(path)
  size = FastImage.size(path)

  UI.user_error!("Could not find or parse file at path '#{path}'") if size.nil? or size.count == 0

  # Walk up two directories and test if we need to handle a platform that doesn't support landscape
  path_component = Pathname.new(path).each_filename.to_a[-3]
  if path_component.eql? "appleTV"
    skip_landscape = true
  end

  # iMessage screenshots have same resolution as app screenshots so we need to distinguish them
  devices = path_component.eql?("iMessage") ? self.device_messages : self.devices

  devices.each do |device_type, array|
    array.each do |resolution|
      if skip_landscape
        if size[0] == resolution[0] and size[1] == resolution[1] # portrait
          return device_type
        end
      else
        if (size[0] == resolution[0] and size[1] == resolution[1]) or # portrait
           (size[1] == resolution[0] and size[0] == resolution[1]) # landscape
          return device_type
        end
      end
    end
  end

  UI.user_error!("Unsupported screen size #{size} for path '#{path}'")
end

.device_messages ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/deliver/app_screenshot.rb', line 113

def self.device_messages
  return {
    ScreenSize::IOS_55_MESSAGES => [
      [1080, 1920],
      [1242, 2208]
    ],
    ScreenSize::IOS_47_MESSAGES => [
      [750, 1334]
    ],
    ScreenSize::IOS_40_MESSAGES => [
      [640, 1136],
      [640, 1096],
      [1136, 600] # landscape status bar is smaller
    ],
    ScreenSize::IOS_IPAD_MESSAGES => [
      [1024, 748],
      [1024, 768],
      [2048, 1496],
      [2048, 1536],
      [768, 1004],
      [768, 1024],
      [1536, 2008],
      [1536, 2048]
    ],
    ScreenSize::IOS_IPAD_PRO_MESSAGES => [
      [2732, 2048],
      [2048, 2732]
    ]
  }
end

.devices ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/deliver/app_screenshot.rb', line 144

def self.devices
  return {
    ScreenSize::IOS_55 => [
      [1080, 1920],
      [1242, 2208]
    ],
    ScreenSize::IOS_47 => [
      [750, 1334]
    ],
    ScreenSize::IOS_40 => [
      [640, 1136],
      [640, 1096],
      [1136, 600] # landscape status bar is smaller
    ],
    ScreenSize::IOS_35 => [
      [640, 960],
      [640, 920],
      [960, 600] # landscape status bar is smaller
    ],
    ScreenSize::IOS_IPAD => [
      [1024, 748],
      [1024, 768],
      [2048, 1496],
      [2048, 1536],
      [768, 1004],
      [768, 1024],
      [1536, 2008],
      [1536, 2048]
    ],
    ScreenSize::IOS_IPAD_PRO => [
      [2732, 2048],
      [2048, 2732]
    ],
    ScreenSize::MAC => [
      [1280, 800],
      [1440, 900],
      [2880, 1800],
      [2560, 1600]
    ],
    ScreenSize::IOS_APPLE_WATCH => [
      [312, 390]
    ],
    ScreenSize::APPLE_TV => [
      [1920, 1080]
    ]
  }
end

Instance Method Details

#device_type ⇒ Object

The iTC API requires a different notation for the device



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/deliver/app_screenshot.rb', line 61

def device_type
  matching = {
    ScreenSize::IOS_35 => "iphone35",
    ScreenSize::IOS_40 => "iphone4",
    ScreenSize::IOS_47 => "iphone6",
    ScreenSize::IOS_55 => "iphone6Plus",
    ScreenSize::IOS_IPAD => "ipad",
    ScreenSize::IOS_IPAD_PRO => "ipadPro",
    ScreenSize::IOS_40_MESSAGES => "iphone4",
    ScreenSize::IOS_47_MESSAGES => "iphone6",
    ScreenSize::IOS_55_MESSAGES => "iphone6Plus",
    ScreenSize::IOS_IPAD_MESSAGES => "ipad",
    ScreenSize::IOS_IPAD_PRO_MESSAGES => "ipadPro",
    ScreenSize::MAC => "desktop",
    ScreenSize::IOS_APPLE_WATCH => "watch",
    ScreenSize::APPLE_TV => "appleTV"
  }
  return matching[self.screen_size]
end

#formatted_name ⇒ Object

Nice name



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/deliver/app_screenshot.rb', line 82

def formatted_name
  matching = {
    ScreenSize::IOS_35 => "iPhone 4",
    ScreenSize::IOS_40 => "iPhone 5",
    ScreenSize::IOS_47 => "iPhone 6",
    ScreenSize::IOS_55 => "iPhone 6 Plus",
    ScreenSize::IOS_IPAD => "iPad",
    ScreenSize::IOS_IPAD_PRO => "iPad Pro",
    ScreenSize::IOS_40_MESSAGES => "iPhone 5 (iMessage)",
    ScreenSize::IOS_47_MESSAGES => "iPhone 6 (iMessage)",
    ScreenSize::IOS_55_MESSAGES => "iPhone 6 Plus (iMessage)",
    ScreenSize::IOS_IPAD_MESSAGES => "iPad (iMessage)",
    ScreenSize::IOS_IPAD_PRO_MESSAGES => "iPad Pro (iMessage)",
    ScreenSize::MAC => "Mac",
    ScreenSize::IOS_APPLE_WATCH => "Watch",
    ScreenSize::APPLE_TV => "Apple TV"
  }
  return matching[self.screen_size]
end

#is_messages? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/deliver/app_screenshot.rb', line 109

def is_messages?
  return [ScreenSize::IOS_40_MESSAGES, ScreenSize::IOS_47_MESSAGES, ScreenSize::IOS_55_MESSAGES, ScreenSize::IOS_IPAD_MESSAGES, ScreenSize::IOS_IPAD_PRO_MESSAGES].include?(self.screen_size)
end

#is_valid? ⇒ Boolean

Validates the given screenshots (size and format)

Returns:

  • (Boolean) 


103
104
105
106
107
 
# File 'lib/deliver/app_screenshot.rb', line 103

def is_valid?
  return false unless ["png", "PNG", "jpg", "JPG", "jpeg", "JPEG"].include?(self.path.split(".").last)

  return self.screen_size == self.class.calculate_screen_size(self.path)
end