Class: Screenpress::Saver

Inherits:
Object
  • Object
show all
Defined in:
lib/screenpress/saver.rb

Defined Under Namespace

Classes: Proxy

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filename, capybara = nil, page = nil) ⇒ Saver

Returns a new instance of Saver.



7
8
9
10
11
 
# File 'lib/screenpress/saver.rb', line 7

def initialize(filename, capybara = nil, page = nil)
  @capybara = capybara || Capybara
  @page     = page || @capybara.page
  @filename = filename
end

Instance Attribute Details

#capybara ⇒ Object (readonly)

Returns the value of attribute capybara.



5
6
7
 
# File 'lib/screenpress/saver.rb', line 5

def capybara
  @capybara
end

#filename ⇒ Object (readonly)

Returns the value of attribute filename.



5
6
7
 
# File 'lib/screenpress/saver.rb', line 5

def filename
  @filename
end

#page ⇒ Object (readonly)

Returns the value of attribute page.



5
6
7
 
# File 'lib/screenpress/saver.rb', line 5

def page
  @page
end

Instance Method Details

#comparator ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/screenpress/saver.rb', line 71

def comparator
  case Screenpress.config.comparator
  when "bits"
    Screenpress::Compare::Bits
  when "phashion", "phash"
    Screenpress::Compare::Phashion
  when "magick"
    raise "ImageMagick comparator not yet implemented"
  when "perceptualdiff"
    raise "perceptualdiff comparator not yet implemented"
  else
    raise "Unknown comparator"
  end
end

#ensure_directory ⇒ Object 



86
87
88
89
90
 
# File 'lib/screenpress/saver.rb', line 86

def ensure_directory
  folder = File.dirname(filename)
  return if File.directory?(folder)
  FileUtils.mkdir_p(folder)
end

#same?(filename, tmp_file) ⇒ Boolean

Returns:

  • (Boolean) 


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

def same?(filename, tmp_file)
  return !File.exists?(tmp_file) if !File.exists?(filename)

  compare = comparator.new(filename, tmp_file)
  if compare.respond_to?(:difference)
    difference = compare.difference
    if compare.respond_to?(:threshold)
      threshold = compare.threshold
    else
      threshold = Screenpress.config.threshold || 0
    end
    if difference > threshold
      puts "   Screenpress #{filename} different: #{difference} > #{threshold}"
      return false
    else
      puts "   Screenpress #{filename} same: #{difference} <= #{threshold}"
      return true
    end
  else
    if compare.same?
      return true
    else
      puts "   Screenpress #{filename} different!"
      return false
    end
  end
end

#save ⇒ Object 



13
14
15
16
17
 
# File 'lib/screenpress/saver.rb', line 13

def save
  # if current_path empty then nothing to screen shot as browser has not loaded any URL
  return false if capybara.current_path.to_s.empty?
  save_screenshot
end

#save_screenshot ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/screenpress/saver.rb', line 19

def save_screenshot
  tmp_file = self.tmp_filename

  # settings to nil because of issues in some version of capybara
  old_path = Capybara.save_and_open_page_path
  Capybara.save_and_open_page_path = nil

  ensure_directory

  return false unless Screenpress::Saver::Proxy.save!(capybara.current_driver, page.driver, tmp_file)

  # is it different?
  if same?(filename, tmp_file)
    File.delete(tmp_file)
  else
    FileUtils.mv(tmp_file, filename)
  end
  return true

rescue Exception => e
  File.delete(tmp_file) if tmp_file && File.exists?(tmp_file)
  raise e
end

#tmp_filename ⇒ Object 



92
93
94
95
96
 
# File 'lib/screenpress/saver.rb', line 92

def tmp_filename
  tmp_dir  = Screenpress.config.full_tmp_path.to_s
  tmp_file = "#{tmp_dir}/screenpress_#{File.basename(filename)}"
  tmp_file
end