wraith 2.8.1 → 3.0.0

data/templates/configs/multiple_domains.yaml

@@ -30,14 +30,8 @@ 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)
-
-# the file in charge of taking the screenshot
-snap_file: "javascript/phantom--nojs.js"
+# the engine to run Wraith with. Examples: 'phantomjs', 'casperjs', 'slimerjs'
+browser: "phantomjs"
 
 # the directory that your base screenshots will be stored in
 history_dir: 'shots_base'

data/templates/configs/spider.yaml

@@ -5,19 +5,19 @@ domains:
 
 # Notice the absence of a `paths` property. When no paths are provided, Wraith defaults to
 # spidering mode to check your entire website.
-​
-​# A list of URLs to skip when spidering.
-# Ruby regular expressions can be​ used, if prefixed with `!ruby/regexp` as defined in the YAML Cookbook​.
-​# See http://www.yaml.org/YAML_for_ruby.html#regexps​
-​spider_skips:​
-  - /foo/bar.html           # Matches /foo/bar.html explicitly​
-​  - !ruby/regexp /^\/baz\// # Matches any URLs that start with /baz​
-
-# the filename of the spider file to use. Default: spider.txt​
+
+# A list of URLs to skip when spidering.
+# Ruby regular expressions can be used, if prefixed with `!ruby/regexp` as defined in the YAML Cookbook​.
+# See http://www.yaml.org/YAML_for_ruby.html#regexps
+spider_skips:
+  - /foo/bar.html           # Matches /foo/bar.html explicitly
+  - !ruby/regexp /^\/baz\// # Matches any URLs that start with /baz
+
+# the filename of the spider file to use. Default: spider.txt
 spider_file: example_com_spider.txt
-​
-​# the number of days to keep the site spider file​
-spider_days: 10​
+
+# the number of days to keep the site spider file
+spider_days: 10
 
 # amount of fuzz ImageMagick will use when comparing images. A higher fuzz makes the comparison less strict.
 fuzz: '20%'
@@ -35,13 +35,7 @@ screen_widths:
   - 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)
-
-# the file in charge of taking the screenshot
-snap_file: "javascript/phantom.js"
+browser: "phantomjs"
 
 # the directory that your latest screenshots will be stored in
 directory: 'shots_nojs'

data/templates/javascript/beforeCapture--casper_example.js

@@ -1,5 +1,12 @@
-module.exports = function (browserEngine) {
-    browserEngine.wait(2000, function() {
-        browserEngine.click('.ns-panel__hotspot--2');
+module.exports = function (casper) {
+
+    /* you may want to test some interaction on the page */
+    casper.wait(2000, function() {
+        casper.click('.ns-panel__hotspot--2');
     });
+
+    /* or you may want to see how your page looks without JavaScript */
+    // casper.options.pageSettings.javascriptEnabled = false;
+    // casper.thenOpen(casper.page.url);
+
 }

data/templates/javascript/beforeCapture--phantom_example.js

@@ -1,9 +1,36 @@
-module.exports = function (browserEngine) {
-    browserEngine.evaluate(function(){
+module.exports = function (phantom) {
+
+    /* you may want to test some interaction on the page */
+    phantom.evaluate(function(){
         var a = document.querySelector('.ns-panel__hotspot--2');
         var e = document.createEvent('MouseEvents');
         e.initMouseEvent('click', true, true, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);
         a.dispatchEvent(e);
         waitforload = true;
     });
+
+    /* or you may want to see how your page looks without JavaScript */
+    // phantom.settings.javascriptEnabled = false;
+    // phantom.open(phantom.page.url);
+
+    // You can place custom headers here, example below.
+    // page.customHeaders = {
+
+    //      'X-Candy-OVERRIDE': 'https://api.live.bbc.co.uk/'
+
+    //  };
+
+    // If you want to set a cookie, just add your details below in the following way.
+
+    // phantom.addCookie({
+    //     'name': 'ckns_policy',
+    //     'value': '111',
+    //     'domain': '.bbc.co.uk'
+    // });
+    // phantom.addCookie({
+    //     'name': 'locserv',
+    //     'value': '1#l1#i=6691484:n=Oxford+Circus:h=e@w1#i=8:p=London@d1#1=l:2=e:3=e:4=2@n1#r=40',
+    //     'domain': '.bbc.co.uk'
+    // });
+
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Dave Blooman
@@ -10,160 +10,160 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: image_size
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: anemone
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: robotex
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: casperjs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Wraith is a screenshot comparison tool, created by developers at BBC
@@ -177,11 +177,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gemset"
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
+- .gemset
+- .gitignore
+- .rubocop.yml
+- .ruby-version
+- .travis.yml
 - Dockerfile
 - Gemfile
 - LICENSE
@@ -198,34 +198,38 @@ files:
 - lib/wraith/gallery.rb
 - lib/wraith/gallery_template/basic_template.erb
 - lib/wraith/gallery_template/slideshow_template.erb
+- lib/wraith/javascript/_helper.js
+- lib/wraith/javascript/_phantom__common.js
+- lib/wraith/javascript/casper.js
+- lib/wraith/javascript/phantom--nojs.js
+- lib/wraith/javascript/phantom.js
 - lib/wraith/save_images.rb
 - lib/wraith/spider.rb
 - lib/wraith/thumbnails.rb
 - lib/wraith/version.rb
 - lib/wraith/wraith.rb
+- spec/_helpers.rb
 - spec/base/global.png
 - spec/base/path.png
+- spec/before_capture_spec.rb
+- spec/config_spec.rb
 - spec/configs/test_config--casper.yaml
 - spec/configs/test_config--phantom.yaml
-- spec/helpers.rb
+- spec/gallery_spec.rb
+- spec/js/custom_snap_file.js
 - spec/js/global.js
 - spec/js/path.js
+- spec/resize_reload_spec.rb
+- spec/save_images_spec.rb
 - spec/thumbnails/home/test_image-afrique.png
 - spec/thumbnails/home/test_image-diff.png
 - spec/thumbnails/home/test_image-russian.png
-- spec/wraith_spec.rb
 - templates/README.md
 - templates/configs/component.yaml
 - templates/configs/multiple_domains.yaml
 - templates/configs/spider.yaml
-- templates/javascript/README.md
-- templates/javascript/_getDimensions.js
-- templates/javascript/_phantom__common.js
 - templates/javascript/beforeCapture--casper_example.js
 - templates/javascript/beforeCapture--phantom_example.js
-- templates/javascript/casper.js
-- templates/javascript/phantom--nojs.js
-- templates/javascript/phantom.js
 - wraith.gemspec
 homepage: https://github.com/BBC-News/wraith
 licenses:
@@ -237,29 +241,34 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Wraith is a screenshot comparison tool, created by developers at BBC News.
 test_files:
+- spec/_helpers.rb
 - spec/base/global.png
 - spec/base/path.png
+- spec/before_capture_spec.rb
+- spec/config_spec.rb
 - spec/configs/test_config--casper.yaml
 - spec/configs/test_config--phantom.yaml
-- spec/helpers.rb
+- spec/gallery_spec.rb
+- spec/js/custom_snap_file.js
 - spec/js/global.js
 - spec/js/path.js
+- spec/resize_reload_spec.rb
+- spec/save_images_spec.rb
 - spec/thumbnails/home/test_image-afrique.png
 - spec/thumbnails/home/test_image-diff.png
 - spec/thumbnails/home/test_image-russian.png
-- spec/wraith_spec.rb

data/spec/wraith_spec.rb

@@ -1,209 +0,0 @@
-require "rspec"
-require "image_size"
-require "helpers"
-require "./lib/wraith/cli"
-
-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 "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
-
-  context "When creating a wraith worker" do
-    it "should have 7 config keys" do
-      expect(wraith.config.keys.size).to be 7
-    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 "When capturing an image" do
-    let(:image_size) { ImageSize.path(test_image1).size }
-
-    it "saves image" do
-      wraith.engine.each do |_type, engine|
-        saving.capture_page_image(engine, test_url1, 320, test_image1, selector, 'false', 'false')
-      end
-
-      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
-
-  describe "When generating gallery" do
-    let(:gallery) { Wraith::GalleryGenerator.new(config_name, false) }
-
-    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
-
-  describe "When hooking into beforeCapture (CasperJS)" do
-    let(:config_name) { get_path_relative_to __FILE__, "./configs/test_config--casper.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:    '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