Class: Capybara::Screenshot::Diff::Drivers::VipsDriver

Inherits:
Object
  • Object
show all
Defined in:
lib/capybara/screenshot/diff/drivers/vips_driver.rb

Defined Under Namespace

Classes: VipsUtil

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(new_file_name, old_file_name = nil, options = {}) ⇒ VipsDriver

Returns a new instance of VipsDriver.



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 21

def initialize(new_file_name, old_file_name = nil, options = {})
  options = old_file_name if old_file_name.is_a?(Hash)

  @new_file_name = new_file_name
  @old_file_name = old_file_name || "#{new_file_name}#{ImageCompare::TMP_FILE_SUFFIX}"

  @options = options || {}

  reset
end

Instance Attribute Details

#new_file_name ⇒ Object (readonly)

Returns the value of attribute new_file_name.



19
20
21
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 19

def new_file_name
  @new_file_name
end

#old_file_name ⇒ Object (readonly)

Returns the value of attribute old_file_name.



19
20
21
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 19

def old_file_name
  @old_file_name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



19
20
21
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 19

def options
  @options
end

Instance Method Details

#add_black_box(memo, region) ⇒ Object 



79
80
81
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 79

def add_black_box(memo, region)
  memo.draw_rect([0, 0, 0, 0], *region, fill: true)
end

#adds_error_details_to(_log) ⇒ Object 



62
63
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 62

def adds_error_details_to(_log)
end

#chunky_png_comparator ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 83

def chunky_png_comparator
  @chunky_png_comparator ||= ImageCompare.new(
    @new_file_name,
    @old_file_name,
    **@options.merge(driver: :chunky_png, tolerance: nil, median_filter_window_size: nil)
  )
end

#crop(dimensions, i) ⇒ Object 



71
72
73
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 71

def crop(dimensions, i)
  i.crop(0, 0, *dimensions)
end

#difference_level(diff_mask, old_img, _region = nil) ⇒ Object 



91
92
93
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 91

def difference_level(diff_mask, old_img, _region = nil)
  VipsUtil.difference_area_size_by(diff_mask).to_f / image_area_size(old_img)
end

#dimension(image) ⇒ Object 



137
138
139
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 137

def dimension(image)
  [image.width, image.height]
end

#dimension_changed?(org_image, new_image) ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
131
132
133
134
135
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 128

def dimension_changed?(org_image, new_image)
  return false if dimension(org_image) == dimension(new_image)

  change_msg = [org_image, new_image].map { |i| "#{i.width}x#{i.height}" }.join(" => ")
  warn "Image size has changed for #{@new_file_name}: #{change_msg}"

  true
end

#draw_rectangles(images, left, top, right, bottom, rgba) ⇒ Object 



141
142
143
144
145
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 141

def draw_rectangles(images, (left, top, right, bottom), rgba)
  images.map do |image|
    image.draw_rect(rgba, left - 1, top - 1, right - left + 2, bottom - top + 2)
  end
end

#filter_image_with_median(image, median_filter_window_size) ⇒ Object 



75
76
77
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 75

def filter_image_with_median(image, median_filter_window_size)
  image.median(median_filter_window_size)
end

#find_difference_region(new_image, old_image, color_distance_limit, _shift_distance_limit, _area_size_limit, fast_fail: false) ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 49

def find_difference_region(new_image, old_image, color_distance_limit, _shift_distance_limit, _area_size_limit, fast_fail: false)
  diff_mask = VipsUtil.difference_mask(color_distance_limit, old_image, new_image)
  region = VipsUtil.difference_region_by(diff_mask)

  [region, diff_mask]
end

#from_file(filename) ⇒ Object 



119
120
121
122
123
124
125
126
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 119

def from_file(filename)
  result = ::Vips::Image.new_from_file(filename)

  result = result.colourspace("srgb") if result.bands < 3
  result = result.bandjoin(255) if result.bands == 3

  result
end

#height_for(image) ⇒ Object 



99
100
101
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 99

def height_for(image)
  image.height
end

#image_area_size(old_img) ⇒ Object 



95
96
97
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 95

def image_area_size(old_img)
  width_for(old_img) * height_for(old_img)
end

#inscribed?(dimensions, i) ⇒ Boolean

old private

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 67

def inscribed?(dimensions, i)
  dimension(i) == dimensions || i.width < dimensions[0] || i.height < dimensions[1]
end

#load_images(old_file_name, new_file_name, driver = self) ⇒ Object 



115
116
117
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 115

def load_images(old_file_name, new_file_name, driver = self)
  [driver.from_file(old_file_name), driver.from_file(new_file_name)]
end

#reset ⇒ Object

Resets the calculated data about the comparison with regard to the “new_image”. Data about the original image is kept.



34
35
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 34

def reset
end

#resize_image_to(image, new_width, new_height) ⇒ Object 



111
112
113
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 111

def resize_image_to(image, new_width, new_height)
  image.resize(1.* new_width / new_height)
end

#save_image_to(image, filename) ⇒ Object 



107
108
109
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 107

def save_image_to(image, filename)
  image.write_to_file(filename)
end

#shift_distance_different? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
46
47
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 43

def shift_distance_different?
  warn "[capybara-screenshot-diff] Instead of shift_distance_limit " \
         "please use median_filter_window_size and color_distance_limit options"
  chunky_png_comparator.different?
end

#shift_distance_equal? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
41
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 37

def shift_distance_equal?
  warn "[capybara-screenshot-diff] Instead of shift_distance_limit " \
         "please use median_filter_window_size and color_distance_limit options"
  chunky_png_comparator.quick_equal?
end

#size(region) ⇒ Object 



56
57
58
59
60
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 56

def size(region)
  return 0 unless region

  (region[2] - region[0]) * (region[3] - region[1])
end

#width_for(image) ⇒ Object 



103
104
105
 
# File 'lib/capybara/screenshot/diff/drivers/vips_driver.rb', line 103

def width_for(image)
  image.width
end