wraith 2.8.1 → 3.0.0

data/spec/{helpers.rb → _helpers.rb}

@@ -1,8 +1,9 @@
+require "rspec"
+require "./lib/wraith/cli"
+
 def create_diff_image
-  wraith.engine.each do |_type, engine|
-    saving.capture_page_image(engine, test_url1, 320, test_image1, selector, 'false', 'false')
-    saving.capture_page_image(engine, test_url2, 320, test_image2, selector, 'false', 'false')
-  end
+  saving.capture_page_image(wraith.engine, test_url1, 320, test_image1, selector, 'false', 'false')
+  saving.capture_page_image(wraith.engine, test_url2, 320, test_image2, selector, 'false', 'false')
 end
 
 def crop_images

data/spec/before_capture_spec.rb

@@ -0,0 +1,81 @@
+require "_helpers"
+
+describe Wraith do
+  let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--casper.yaml" }
+  let(:test_url1) { "http://www.bbc.com/afrique" }
+  let(:diff_image) { "shots/test/test_diff.png" }
+  let(:data_txt) { "shots/test/test.txt" }
+  let(:saving) { Wraith::SaveImages.new(config_name) }
+  let(:wraith) { Wraith::Wraith.new(config_name) }
+  let(:selector) { "body" }
+  let(:before_suite_js) { "spec/js/global.js" }
+  let(:before_capture_js) { "spec/js/path.js" }
+
+  describe "When hooking into beforeCapture (CasperJS)" do
+
+    it "Executes the global JS before capturing" do
+      run_js_then_capture(
+        global_js: before_suite_js,
+        path_js:   'false',
+        output_should_look_like: 'spec/base/global.png',
+        engine:    'casperjs'
+      )
+    end
+
+    it "Executes the path-level JS before capturing" do
+      run_js_then_capture(
+        global_js: 'false',
+        path_js: before_capture_js,
+        output_should_look_like: 'spec/base/path.png',
+        engine:    'casperjs'
+      )
+    end
+
+    it "Executes the global JS before the path-level JS" do
+      run_js_then_capture(
+        global_js: before_suite_js,
+        path_js: before_capture_js,
+        output_should_look_like: 'spec/base/path.png',
+        engine:    'casperjs'
+      )
+    end
+  end
+
+  # @TODO - uncomment and figure out why broken
+  # describe "When hooking into beforeCapture (PhantomJS)" do
+  #   let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--phantom.yaml" }
+  #   let(:saving) { Wraith::SaveImages.new(config_name) }
+  #   let(:wraith) { Wraith::Wraith.new(config_name) }
+  #   let(:selector) { "body" }
+  #   let(:before_suite_js) { "../../spec/js/global.js" }
+  #   let(:before_capture_js) { "../../spec/js/path.js" }
+
+  #   it "Executes the global JS before capturing" do
+  #     run_js_then_capture(
+  #       global_js: before_suite_js,
+  #       path_js:   'false',
+  #       output_should_look_like: 'spec/base/global.png',
+  #       engine:    'phantomjs'
+  #     )
+  #   end
+
+  #   it "Executes the path-level JS before capturing" do
+  #     run_js_then_capture(
+  #       global_js: 'false',
+  #       path_js: before_capture_js,
+  #       output_should_look_like: 'spec/base/path.png',
+  #       engine:    'phantomjs'
+  #     )
+  #   end
+
+  #   it "Executes the global JS before the path-level JS" do
+  #     run_js_then_capture(
+  #       global_js: before_suite_js,
+  #       path_js: before_capture_js,
+  #       output_should_look_like: 'spec/base/path.png',
+  #       engine:    'phantomjs'
+  #     )
+  #   end
+  # end
+
+end

data/spec/config_spec.rb

@@ -0,0 +1,139 @@
+require "_helpers"
+
+describe "wraith config" do
+
+  let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--phantom.yaml" }
+  let(:wraith) { Wraith::Wraith.new(config_name) }
+
+  describe "Config" do
+    it "returns a Wraith class" do
+      expect(wraith).is_a? Wraith::Wraith
+    end
+
+    it "when config is loaded" do
+      expect(wraith).to respond_to :config
+    end
+
+    it "contains shot options" do
+      expect(wraith.config).to include "directory" => "shots"
+    end
+  end
+
+  describe "When creating a wraith worker" do
+
+    it "should have a browser engine defined" do
+      expect(wraith.engine).to be_a String
+    end
+
+    it "should have a directory defined" do
+      expect(wraith.directory).to be_a String
+    end
+
+    it "should have domains defined" do
+      expect(wraith.domains).to be_a Hash
+    end
+
+    it "should have screen widths defined" do
+      expect(wraith.widths).to be_a Array
+    end
+
+    it "should have paths defined" do
+      expect(wraith.paths).to be_a Hash
+    end
+
+    it "should have fuzz defined" do
+      expect(wraith.fuzz).to be_a String
+    end
+
+    it "should have widths" do
+      expect(wraith.widths).to eq [320, 600, 1280]
+    end
+
+    it "include base domain" do
+      expect(wraith.base_domain).to eq "http://www.bbc.com/afrique"
+    end
+
+    it "include compare domain" do
+      expect(wraith.comp_domain).to eq "http://www.bbc.com/russian"
+    end
+
+    it "include base label" do
+      expect(wraith.base_domain_label).to eq "afrique"
+    end
+
+    it "include compare label" do
+      expect(wraith.comp_domain_label).to eq "russian"
+    end
+
+    it "include compare label" do
+      expect(wraith.paths).to eq("home" => "/", "uk_index" => "/uk")
+    end
+  end
+
+  describe "different ways of initialising browser engine" do
+
+    it "should let us directly specify the engine" do
+      config = YAML.load 'browser: phantomjs'
+      wraith = Wraith::Wraith.new(config, true)
+
+      expect(wraith.engine).to eq 'phantomjs'
+    end
+
+    it "should be backwards compatible with the old way" do
+      config = YAML.load '
+        browser:
+          phantomjs: "casperjs"
+      '
+      wraith = Wraith::Wraith.new(config, true)
+      expect(wraith.engine).to eq 'casperjs'
+    end
+  end
+
+  describe "different ways of determining the snap file" do
+
+    it "should calculate the snap file from the engine" do
+      config = YAML.load 'browser: phantomjs'
+      wraith = Wraith::Wraith.new(config, true)
+      expect(wraith.snap_file).to include 'lib/wraith/javascript/phantom.js'
+
+      config = YAML.load 'browser: casperjs'
+      wraith = Wraith::Wraith.new(config, true)
+      expect(wraith.snap_file).to include 'lib/wraith/javascript/casper.js'
+    end
+
+    it "should calculate the snap file in a backwards-compatible way" do
+      config = YAML.load '
+        browser:
+          phantomjs: "casperjs"
+      '
+      wraith = Wraith::Wraith.new(config, true)
+      expect(wraith.snap_file).to include 'lib/wraith/javascript/casper.js'
+    end
+
+    it "should allow users to specify their own snap file" do
+      config = YAML.load '
+        browser:   casperjs
+        snap_file: path/to/snap.js
+      '
+      wraith = Wraith::Wraith.new(config, true)
+      expect(wraith.snap_file).to eq 'path/to/snap.js'
+    end
+  end
+
+  describe "different modes of efficiency (resize or reload)" do
+
+    it "should trigger efficient mode if resize was specified" do
+      config = YAML.load 'resize_or_reload: "resize"'
+      wraith = Wraith::Wraith.new(config, true)
+      expect(wraith.resize)
+    end
+
+    it "should fall back to slow mode if reload was specified" do
+      config = YAML.load 'resize_or_reload: "reload"'
+      wraith = Wraith::Wraith.new(config, true)
+      expect(wraith.resize).to eq false
+    end
+
+  end
+
+end

data/spec/configs/test_config--casper.yaml

@@ -8,8 +8,8 @@ browser:
   phantomjs: "casperjs"
   # slimerjs: "slimerjs"
 
-#If you want to have multiple snapping files, set the file name here
-snap_file: "templates/javascript/casper.js"
+#overriding the snap file
+snap_file: "spec/js/custom_snap_file.js"
 
 # Type the name of the directory that shots will be stored in
 directory: 'shots'

data/spec/configs/test_config--phantom.yaml

@@ -6,10 +6,10 @@
 #Headless browser option
 browser:
   phantomjs: "phantomjs"
-  # slimerjs: "slimerjs"
 
-#If you want to have multiple snapping files, set the file name here
-snap_file: "templates/javascript/phantom.js"
+# we've deliberately left out the snap_file
+
+resize_or_reload: resize
 
 # Type the name of the directory that shots will be stored in
 directory: 'shots'

data/spec/gallery_spec.rb

@@ -0,0 +1,38 @@
+require "_helpers"
+
+describe Wraith do
+  let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--phantom.yaml" }
+  let(:gallery) { Wraith::GalleryGenerator.new(config_name, false) }
+
+  describe "When generating gallery" do
+
+    it "should not break when there is a `-` in the filename" do
+      dirs = gallery.parse_directories 'spec/thumbnails'
+
+      images = [
+        {
+          :filename => 'home/test_image-afrique.png',
+          :thumb    => 'thumbnails/home/test_image-afrique.png'
+        },
+        {
+          :filename => 'home/test_image-russian.png',
+          :thumb    => 'thumbnails/home/test_image-russian.png'
+        }
+      ]
+
+      dirs['home'][0][:variants].each_with_index do |image, i|
+        expect(image[:filename]).to eq images[i][:filename]
+        expect(image[:thumb]).to eq images[i][:thumb]
+      end
+
+      diff = {
+        :filename => 'home/test_image-diff.png',
+        :thumb    => 'thumbnails/home/test_image-diff.png'
+      }
+
+      expect(dirs['home'][0][:diff][:filename]).to eq 'home/test_image-diff.png'
+      expect(dirs['home'][0][:diff][:thumb]).to eq 'thumbnails/home/test_image-diff.png'
+    end
+  end
+
+end

data/{templates/javascript/casper.js → spec/js/custom_snap_file.js}

@@ -4,7 +4,11 @@ var system = require('system'),
 
 // command line arguments
 var url = casper.cli.get(0),
-    dimensions = requireRelative('_getDimensions.js')(casper.cli.get(1)),
+    dimensions_tmp = /(\d*)x?((\d*))?/i.exec(casper.cli.get(1));
+    dimensions = {
+        'viewportWidth':  parseInt(dimensions_tmp[1]),
+        'viewportHeight': parseInt(dimensions_tmp[2] || 1500)
+    },
     image_name = casper.cli.get(2),
     selector = casper.cli.get(3),
     globalBeforeCaptureJS = casper.cli.get(4),

data/spec/resize_reload_spec.rb

@@ -0,0 +1,55 @@
+require "_helpers"
+
+describe "wraith config" do
+
+  let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--phantom.yaml" }
+  let(:saving) { Wraith::SaveImages.new(config_name) }
+
+  describe "saving images" do
+
+    it "should pass the width plainly to the CLI when running in inefficient mode" do
+      prepared_width = saving.prepare_widths_for_cli 432
+      expect(prepared_width).to eq 432
+    end
+
+    it "should pass an array of widths to CLI when running in efficient mode" do
+      prepared_width = saving.prepare_widths_for_cli [432, 21, 100]
+      expect(prepared_width).to eq "'432','21','100'"
+    end
+
+    it "should create fewer jobs when in efficient mode" do
+      base_config = '
+        domains:
+          test: http://www.bbc.com
+        paths:
+          test: /mypage
+        screen_widths:
+          - 320
+          - 464
+          - 624
+      '
+      efficient_config = YAML.load(base_config + "
+        resize_or_reload: resize
+      ")
+      efficient_saving = Wraith::SaveImages.new(efficient_config, false, true)
+      inefficient_config = YAML.load(base_config + "
+        resize_or_reload: reload
+      ")
+      inefficient_saving = Wraith::SaveImages.new(inefficient_config, false, true)
+
+      efficient_jobs   = efficient_saving.define_jobs
+      inefficient_jobs = inefficient_saving.define_jobs
+
+      expect(efficient_jobs.length).to be 1
+      expect(inefficient_jobs.length).to be 3 # 1 for each screen width
+
+      # [["test", "/mypage", "'320','464','624'", "http://www.bbc.com/mypage", "/test/MULTI__test.png", " ", "false", "false"]]
+      expect(efficient_jobs[0][2]).to eq "'320','464','624'"
+
+      # [["test", "/mypage", 320, "http://www.bbc.com/mypage", "/test/320__test.png", " ", "false", "false"], ["test", "/mypage", 464, "http://www.bbc.com/mypage", "/test/464__test.png", " ", "false", "false"], ["test", "/mypage", 624, "http://www.bbc.com/mypage", "/test/624__test.png", " ", "false", "false"]]
+      expect(inefficient_jobs[0][2]).to eq 320
+    end
+
+  end
+
+end

data/spec/save_images_spec.rb

@@ -0,0 +1,54 @@
+require "_helpers"
+require "image_size"
+
+describe Wraith do
+  let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--phantom.yaml" }
+  let(:test_url1) { "http://www.bbc.com/afrique" }
+  let(:test_url2) { "http://www.bbc.com/russian" }
+  let(:test_image1) { "shots/test/test1.png" }
+  let(:test_image2) { "shots/test/test(2).png" }
+  let(:diff_image) { "shots/test/test_diff.png" }
+  let(:data_txt) { "shots/test/test.txt" }
+  let(:selector) { "" }
+  let(:saving) { Wraith::SaveImages.new(config_name) }
+  let(:wraith) { Wraith::Wraith.new(config_name) }
+
+  before(:each) do
+    Wraith::FolderManager.new(config_name).clear_shots_folder
+    Dir.mkdir("shots/test")
+  end
+
+  describe "When capturing an image" do
+    let(:image_size) { ImageSize.path(test_image1).size }
+
+    it "saves image" do
+      saving.capture_page_image(wraith.engine, test_url1, 320, test_image1, selector, 'false', 'false')
+      expect(image_size[0]).to eq 320
+    end
+  end
+
+  describe "When comparing images" do
+    it "should compare" do
+      create_diff_image
+      crop_images
+      compare_images
+
+      diff = ImageSize.path(diff_image).size
+
+      expect(diff[0]).to eq 320
+    end
+  end
+
+  describe "When generating thumbnails" do
+    it "produce thumbnails" do
+      create_diff_image
+      crop_images
+      Wraith::CompareImages.new(config_name).compare_task(test_image1, test_image2, diff_image, data_txt)
+      Wraith::Thumbnails.new(config_name).generate_thumbnails
+
+      expect(File).to exist("shots/thumbnails/test/test1.png")
+      expect(File).to exist("shots/thumbnails/test/test(2).png")
+      expect(File).to exist("shots/thumbnails/test/test_diff.png")
+    end
+  end
+end

data/templates/configs/component.yaml

@@ -34,14 +34,11 @@ screen_widths:
   - 1024
   - 1280
 
-# the engine to run Wraith with.
-browser:
-  phantomjs: "casperjs"   # variant of PhantomJS that allows screenshots by element selector
-  #phantomjs: "phantomjs" # PhantomJS, built on top of Webkit and JavascriptCore (like Safari)
-  #slimerjs: "slimerjs"   # SlimerJS, built on top of Gecko and SpiderMonkey (like Firefox)
+# resize to each screen width, or reload at each screen width. (The former is more efficient).
+resize_or_reload: 'resize'
 
-# the file in charge of taking the screenshot
-snap_file: "javascript/casper.js"
+# the engine to run Wraith with.
+browser: "casperjs"
 
 # the directory that your base screenshots will be stored in
 history_dir: 'shots_base'