Class: CypressViewportUpdater::Viewport

Inherits:
Object
  • Object
show all
Defined in:
app/sidekiq/cypress_viewport_updater/viewport.rb

Constant Summary collapse

DEVICES = 
{
  '1920x1080' => 'Microsoft Windows RT Tablet',
  '1280x720' => 'Microsoft Windows RT Tablet',
  '1024x1366' => 'iPad Pro (1st gen 12.9"), '\
                 'iPad Pro (2nd gen 12.9"), '\
                 'iPad Pro (3rd gen 12.9"), iPad Pro (4th gen 12.9")',
  '834x1194' => 'iPad Pro (3rd gen 11"), iPad Pro (4th gen 11")',
  '810x1080' => 'iPad 7th gen',
  '800x1280' => 'Amazon KSFUWI Fire HD 10 (2017), '\
                'Amazon KFMAWI Fire HD 10 (2019), '\
                'Samsung SM-T580 Galaxy Tab A 10.1, '\
                'Samsung SM-T510 Galaxy Tab A 10.1 (2019), '\
                'Samsung SM-T560NU Galaxy Tab E',
  '768x1024' => 'iPad 1-6, iPad mini, iPad Air 1-2, iPad Pro (1st gen 9.7")',
  '601x962' => 'Amazon KFGIWI Kindle Fire HD 8 2016, '\
               'Amazon KFDOWI Kindle Fire HD 8 (2017), '\
               'Amazon KFKAWI Fire HD 8 (2018), '\
               'Amazon KFKAWI Fire HD 8 (2018)',
  '428x926' => 'iPhone 12 Pro Max',
  '414x896' => 'iPhone XS Max, iPhone XR, iPhone 11, iPhone 11 Pro Max',
  '414x736' => 'iPhone 6 Plus, iPhone 6s Plus, iPhone 7 Plus, iPhone 8 Plus',
  '390x844' => 'iPhone 12 Pro, iPhone 12',
  '375x812' => 'iPhone X, iPhone XS, iPhone 11 Pro',
  '375x667' => 'iPhone SE 2nd gen, iPhone 6, iPhone 6s, iPhone 7, iPhone 8',
  '360x780' => 'iPhone 12 mini',
  '360x640' => 'Various Samsung Galaxy, Motorola, Huawei, and other phones',
  '320x568' => 'iPhone 5, iPhone 5s, iPhone 5c, iPhone SE 1st gen',
  '320x480' => 'iPhone 1st gen, iPhone 3G, iPhone 3GS, iPhone 4'
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(row:, rank:, total_users:) ⇒ Viewport

rubocop:enable Naming/MethodName



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 42

def initialize(row:, rank:, total_users:)
  number_of_users = row.metrics.first.values.first.to_f
  device = row.dimensions[0]
  resolution = row.dimensions[1]
  dimensions = resolution.split('x').map(&:to_i)

  @list = "VA Top #{device.capitalize} Viewports"
  @rank = rank
  # variable names are converted to json and must be snakeCase
  # rubocop:disable Naming/VariableName
  @devicesWithViewport = device_list(device:, resolution:)
  @percentTraffic = "#{calculate_percentage_of_users_who_use_viewport(number_of_users, total_users)}%"
  @percentTrafficPeriod = traffic_period
  @viewportPreset = "va-top-#{device}-#{rank}"
  # rubocop:enable Naming/VariableName
  @width = dimensions[0]
  @height = dimensions[1]
end

Instance Attribute Details

#devicesWithViewport ⇒ Object (readonly)

method names are converted to json and must be snakeCase rubocop:disable Naming/MethodName



37
38
39
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 37

def devicesWithViewport
  @devicesWithViewport
end

#height ⇒ Object (readonly)

method names are converted to json and must be snakeCase rubocop:disable Naming/MethodName



37
38
39
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 37

def height
  @height
end

#list ⇒ Object (readonly)

method names are converted to json and must be snakeCase rubocop:disable Naming/MethodName



37
38
39
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 37

def list
  @list
end

#percentTraffic ⇒ Object (readonly)

method names are converted to json and must be snakeCase rubocop:disable Naming/MethodName



37
38
39
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 37

def percentTraffic
  @percentTraffic
end

#percentTrafficPeriod ⇒ Object (readonly)

method names are converted to json and must be snakeCase rubocop:disable Naming/MethodName



37
38
39
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 37

def percentTrafficPeriod
  @percentTrafficPeriod
end

#rank ⇒ Object

method names are converted to json and must be snakeCase rubocop:disable Naming/MethodName



37
38
39
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 37

def rank
  @rank
end

#viewportPreset ⇒ Object

method names are converted to json and must be snakeCase rubocop:disable Naming/MethodName



37
38
39
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 37

def viewportPreset
  @viewportPreset
end

#width ⇒ Object (readonly)

method names are converted to json and must be snakeCase rubocop:disable Naming/MethodName



37
38
39
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 37

def width
  @width
end

Instance Method Details

#calculate_percentage_of_users_who_use_viewport(number_of_users, total_users) ⇒ Object (private) 



77
78
79
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 77

def calculate_percentage_of_users_who_use_viewport(number_of_users, total_users)
  (number_of_users / total_users * 100).round(2)
end

#device_list(device:, resolution:) ⇒ Object (private)

rubocop:enable Naming/MethodName



69
70
71
72
73
74
75
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 69

def device_list(device:, resolution:)
  return 'This property is not set for desktops.' if device == 'desktop'

  DEVICES[resolution] ||
    'This viewport is missing from the devices lookup table. '\
    'Please contact the Testing Tools Team to have it added.'
end

#format_date(date) ⇒ Object (private) 



87
88
89
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 87

def format_date(date)
  date.strftime('%m/%d/%Y')
end

#traffic_period ⇒ Object (private) 



81
82
83
84
85
 
# File 'app/sidekiq/cypress_viewport_updater/viewport.rb', line 81

def traffic_period
  start_date = CypressViewportUpdater::UpdateCypressViewportsJob::START_DATE
  end_date = CypressViewportUpdater::UpdateCypressViewportsJob::END_DATE
  "From: #{format_date(start_date)}, To: #{format_date(end_date)}"
end