Class: Snapshot::ReportsGenerator

Inherits:
Object
  • Object
show all
Defined in:
snapshot/lib/snapshot/reports_generator.rb

Instance Method Summary collapse

Instance Method Details

#available_devicesObject


108
109
110
111
112
113
114
# File 'snapshot/lib/snapshot/reports_generator.rb', line 108

def available_devices
  if Helper.xcode_at_least?("9.0")
    return xcode_9_and_above_device_name_mappings
  else
    return xcode_8_and_below_device_name_mappings
  end
end

#generateObject


8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'snapshot/lib/snapshot/reports_generator.rb', line 8

def generate
  UI.message("Generating HTML Report")

  screens_path = Snapshot.config[:output_directory]

  @data = {}

  Dir[File.join(screens_path, "*")].sort.each do |language_folder|
    language = File.basename(language_folder)
    Dir[File.join(language_folder, '*.png')].sort.each do |screenshot|
      available_devices.each do |key_name, output_name|
        next unless File.basename(screenshot).include?(key_name)
        # This screenshot is 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)
      end
    end
  end

  html_path = File.join(Snapshot::ROOT, "lib", "snapshot/page.html.erb")
  html = ERB.new(File.read(html_path)).result(binding) # https://web.archive.org/web/20160430190141/www.rrn.dk/rubys-erb-templating-system

  export_path = "#{screens_path}/screenshots.html"
  File.write(export_path, html)

  export_path = File.expand_path(export_path)
  UI.success("Successfully created HTML file with an overview of all the screenshots: '#{export_path}'")
  system("open '#{export_path}'") unless Snapshot.config[:skip_open_summary]
end

#xcode_8_and_below_device_name_mappingsObject


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'snapshot/lib/snapshot/reports_generator.rb', line 42

def xcode_8_and_below_device_name_mappings
  # The order IS important, since those names are used to check for include?
  # and the iPhone 6 is included in the iPhone 6 Plus
  {
    'AppleTV1080p' => 'Apple TV',
    'iPhone7Plus' => "iPhone7Plus (5.5-Inch)",
    'iPhone7' => "iPhone7 (4.7-Inch)",
    'iPhone6sPlus' => "iPhone6sPlus (5.5-Inch)",
    'iPhone6Plus' => "iPhone6Plus (5.5-Inch)",
    'iPhone6s' => "iPhone6s (4.7-Inch)",
    'iPhone6' => "iPhone6 (4.7-Inch)",
    'iPhone5' => "iPhone5 (4-Inch)",
    'iPhone4' => "iPhone4 (3.5-Inch)",
    'iPhoneSE' => "iPhone SE",
    'iPad2' => "iPad2",
    'iPadAir2' => 'iPad Air 2',
    'iPadPro(12.9-inch)' => 'iPad Air Pro (12.9-inch)',
    'iPadPro(9.7-inch)' => 'iPad Air Pro (9.7-inch)',
    'iPadPro(9.7inch)' => "iPad Pro (9.7-inch)",
    'iPadPro(12.9inch)' => "iPad Pro (12.9-inch)",
    'iPadPro' => "iPad Pro",
    'iPad' => "iPad",
    'Mac' => "Mac"
  }
end

#xcode_9_and_above_device_name_mappingsObject


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'snapshot/lib/snapshot/reports_generator.rb', line 68

def xcode_9_and_above_device_name_mappings
  {
    # snapshot in Xcode 9 saves screenshots with the SIMULATOR_DEVICE_NAME
    # which includes spaces
    'iPhone XS Max' => "iPhone XS Max",
    'iPhone XS' => "iPhone XS",
    'iPhone XR' => "iPhone XR",
    'iPhone 8 Plus' => "iPhone 8 Plus",
    'iPhone 8' => "iPhone 8",
    'iPhone X' => "iPhone X",
    'iPhone 7 Plus' => "iPhone 7 Plus (5.5-Inch)",
    'iPhone 7' => "iPhone 7 (4.7-Inch)",
    'iPhone 6s Plus' => "iPhone 6s Plus (5.5-Inch)",
    'iPhone 6 Plus' => "iPhone 6 Plus (5.5-Inch)",
    'iPhone 6s' => "iPhone 6s (4.7-Inch)",
    'iPhone 6' => "iPhone 6 (4.7-Inch)",
    'iPhone 5s' => "iPhone 5s (4-Inch)",
    'iPhone 5' => "iPhone 5 (4-Inch)",
    'iPhone SE' => "iPhone SE",
    'iPhone 4s' => "iPhone 4s (3.5-Inch)",
    'iPad 2' => 'iPad 2',
    'iPad Air 2' => 'iPad Air 2',
    'iPad Air' => 'iPad Air',
    'iPad (5th generation)' => 'iPad (5th generation)',
    'iPad Pro (9.7-inch)' => 'iPad Pro (9.7-inch)',
    'iPad Pro (9.7 inch)' => 'iPad Pro (9.7-inch)', # iOS 10.3.1 simulator
    'iPad Pro (10.5-inch)' => 'iPad Pro (10.5-inch)',
    'iPad Pro (11-inch)' => 'iPad Pro (11-inch)',
    'iPad Pro (12.9-inch) (2nd generation)' => 'iPad Pro (12.9-inch) (2nd generation)',
    'iPad Pro (12.9-inch)' => 'iPad Pro (12.9-inch)',
    'iPad Pro (12.9 inch)' => 'iPad Pro (12.9-inch)', # iOS 10.3.1 simulator
    'iPad Pro' => 'iPad Pro (12.9-inch)', # iOS 9.3 simulator
    'Apple TV 1080p' => 'Apple TV',
    'Apple TV 4K (at 1080p)' => 'Apple TV 4K (at 1080p)',
    'Apple TV 4K' => 'Apple TV 4K',
    'Apple TV' => 'Apple TV',
    'Mac' => 'Mac'
  }
end