vulture 1.0.0a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +7 -0
  2. data/config.yml +7 -0
  3. data/templates/report_template.html.erb +20 -0
  4. data/vulture.rb +74 -0
  5. metadata +133 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: d1ebd96f1d894309b29f50810621af5b69fc25673ac74b080c76560748d3eb4b
4
+ data.tar.gz: '0986065eb99b0fe08b51a749b78f6493d91f5c29fcf308d84ff8f4fd67e92db3'
5
+ SHA512:
6
+ metadata.gz: 03d829a45e25384a4c29f97ce5219c9d4194a6c3b68effa6773b5bb51f34406095339805c4ae5cd72741c844cbfc4e85bf36f39fe3626f4d33ebdf3f6b6e746c
7
+ data.tar.gz: 43cf87860b11276bc160195ad7790efa5760bc69e00e6e5e0960e6f974d8d7dcaf7684ee0938b371ef6172ffe3b32919b2d1a556cbb1220891fdbe8724f44a68
data/config.yml ADDED
@@ -0,0 +1,7 @@
1
+ # config.yml
2
+ resolutions:
3
+ - '1024x768'
4
+ - '1280x800'
5
+ - '1920x1080'
6
+
7
+ threshold: 1.0 # % of different pixels that triggers a failure
data/templates/report_template.html.erb ADDED
@@ -0,0 +1,20 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Vulture Report</title>
5
+ <style>
6
+ body { font-family: Arial, sans-serif; }
7
+ .screenshot { display: inline-block; margin: 10px; }
8
+ .diff { border: 2px solid red; }
9
+ </style>
10
+ </head>
11
+ <body>
12
+ <h1>Vulture Screenshot Comparison Report</h1>
13
+ <% diffs.each do |diff| %>
14
+ <div class="screenshot">
15
+ <h2><%= diff[:url] %> at <%= diff[:resolution] %></h2>
16
+ <img src="<%= diff[:diff_path] %>" alt="Diff for <%= diff[:url] %> at <%= diff[:resolution] %>" class="diff">
17
+ </div>
18
+ <% end %>
19
+ </body>
20
+ </html>
data/vulture.rb ADDED
@@ -0,0 +1,74 @@
1
+ #!/usr/bin/env ruby
2
+ require 'capybara'
3
+ require 'capybara/dsl'
4
+ require 'selenium-webdriver'
5
+ require 'chunky_png'
6
+ require 'yaml'
7
+ require 'erb'
8
+
9
+ config = YAML.load_file('config.yml')
10
+
11
+ Capybara.default_driver = :selenium
12
+ Capybara.register_driver :selenium do |app|
13
+ Capybara::Selenium::Driver.new(app, browser: :chrome)
14
+ end
15
+
16
+ include Capybara::DSL
17
+
18
+ def capture_screenshot(url, resolution, output_path)
19
+ width, height = resolution.split('x').map(&:to_i)
20
+ page.driver.browser.manage.window.resize_to(width, height)
21
+ visit(url)
22
+ save_screenshot(output_path)
23
+ end
24
+
25
+ def compare_images(img1_path, img2_path, diff_output_path, threshold)
26
+ img1 = ChunkyPNG::Image.from_file(img1_path)
27
+ img2 = ChunkyPNG::Image.from_file(img2_path)
28
+ diff = ChunkyPNG::Image.new(img1.width, img1.height, ChunkyPNG::Color::TRANSPARENT)
29
+ diff_count = 0
30
+
31
+ img1.height.times do |y|
32
+ img1.width.times do |x|
33
+ if img1[x, y] != img2[x, y]
34
+ diff[x, y] = ChunkyPNG::Color.rgb(255, 0, 0)
35
+ diff_count += 1
36
+ end
37
+ end
38
+ end
39
+
40
+ diff.save(diff_output_path)
41
+ diff_percentage = (diff_count.to_f / (img1.width * img1.height)) * 100
42
+
43
+ puts "Comparison complete: #{diff_count} pixels differ (#{diff_percentage.round(2)}%)."
44
+ exit(1) if diff_percentage > threshold
45
+ end
46
+
47
+ def generate_report(diffs)
48
+ template = File.read('templates/report_template.html.erb')
49
+ renderer = ERB.new(template)
50
+ File.open('report.html', 'w') { |file| file.write(renderer.result(binding)) }
51
+ end
52
+
53
+ if ARGV.length != 2
54
+ puts "Usage: vulture <url1> <url2>"
55
+ exit
56
+ end
57
+
58
+ url1 = ARGV[0]
59
+ url2 = ARGV[1]
60
+
61
+ diffs = []
62
+ config['resolutions'].each do |resolution|
63
+ baseline_path = "screenshots/baseline/#{resolution}_#{url1.gsub(%r{https?://}, '').gsub('/', '_')}.png"
64
+ latest_path = "screenshots/latest/#{resolution}_#{url2.gsub(%r{https?://}, '').gsub('/', '_')}.png"
65
+ diff_path = "screenshots/diff/#{resolution}_#{url1.gsub(%r{https?://}, '').gsub('/', '_')}_diff.png"
66
+
67
+ capture_screenshot(url1, resolution, baseline_path)
68
+ capture_screenshot(url2, resolution, latest_path)
69
+
70
+ compare_images(baseline_path, latest_path, diff_path, config['threshold'])
71
+ diffs << { url: url1, resolution: resolution, diff_path: diff_path }
72
+ end
73
+
74
+ generate_report(diffs)
metadata ADDED
@@ -0,0 +1,133 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: vulture
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0a
5
+ platform: ruby
6
+ authors:
7
+ - zeusssz
8
+ autorequire:
9
+ bindir: "."
10
+ cert_chain: []
11
+ date: 2024-09-11 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: capybara
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3.35'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '3.35'
27
+ - !ruby/object:Gem::Dependency
28
+ name: selenium-webdriver
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '4.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '4.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: chunky_png
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.4'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.4'
55
+ - !ruby/object:Gem::Dependency
56
+ name: erb
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.2'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.2'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '13.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '13.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.10'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.10'
97
+ description: Vulture captures and compares screenshots of web pages at multiple resolutions,
98
+ highlighting visual differences.
99
+ email:
100
+ executables:
101
+ - vulture.rb
102
+ extensions: []
103
+ extra_rdoc_files: []
104
+ files:
105
+ - "./vulture.rb"
106
+ - config.yml
107
+ - templates/report_template.html.erb
108
+ - vulture.rb
109
+ homepage:
110
+ licenses:
111
+ - MIT
112
+ metadata: {}
113
+ post_install_message:
114
+ rdoc_options: []
115
+ require_paths:
116
+ - lib
117
+ required_ruby_version: !ruby/object:Gem::Requirement
118
+ requirements:
119
+ - - ">="
120
+ - !ruby/object:Gem::Version
121
+ version: '0'
122
+ required_rubygems_version: !ruby/object:Gem::Requirement
123
+ requirements:
124
+ - - ">"
125
+ - !ruby/object:Gem::Version
126
+ version: 1.3.1
127
+ requirements: []
128
+ rubygems_version: 3.3.27
129
+ signing_key:
130
+ specification_version: 4
131
+ summary: A CLI tool for automated visual regression testing by comparing screenshots
132
+ of web pages.
133
+ test_files: []