RubyGems - wraith - Versions diffs - 2.6.0 → 2.7.0 - Mend

wraith 2.6.0 → 2.7.0

Files changed (42) hide show

checksums.yaml +4 -4
data/README.md +1 -1
data/{wraith-logo.png → assets/wraith-logo.png} +0 -0
data/lib/wraith/cli.rb +2 -9
data/lib/wraith/folder.rb +5 -1
data/lib/wraith/gallery.rb +11 -1
data/lib/wraith/gallery_template/gallery_template.erb +3 -0
data/lib/wraith/version.rb +1 -1
data/lib/wraith/wraith.rb +1 -1
data/{configs → spec/configs}/test_config--casper.yaml +6 -1
data/{configs/test_config.yaml → spec/configs/test_config--phantom.yaml} +6 -1
data/spec/helpers.rb +6 -2
data/spec/js/global.js +2 -2
data/spec/js/path.js +2 -2
data/spec/thumbnails/test/test_image-1.png +0 -0
data/spec/thumbnails/test/test_image-2.png +0 -0
data/spec/thumbnails/test/test_image-diff.png +0 -0
data/spec/wraith_spec.rb +79 -7
data/templates/README.md +5 -0
data/templates/configs/component.yaml +58 -0
data/templates/configs/multiple_domains.yaml +54 -0
data/templates/configs/spider.yaml +54 -0
data/templates/javascript/README.md +5 -0
data/templates/javascript/_getDimensions.js +7 -0
data/templates/javascript/_phantom__common.js +122 -0
data/templates/javascript/beforeCapture--casper_example.js +5 -0
data/templates/javascript/beforeCapture--phantom_example.js +9 -0
data/templates/javascript/casper.js +59 -0
data/templates/javascript/phantom--nojs.js +6 -0
data/templates/javascript/phantom.js +6 -0
metadata +26 -17
data/configs/component.yaml +0 -47
data/configs/config_nojs.yaml +0 -43
data/configs/custom_height.yaml +0 -42
data/configs/history.yaml +0 -52
data/configs/templates/component.yaml +0 -51
data/configs/templates/config.yaml +0 -43
data/lib/wraith/javascript/beforeCapture.js +0 -5
data/lib/wraith/javascript/casper.js +0 -48
data/lib/wraith/javascript/customHeight.js +0 -99
data/lib/wraith/javascript/nojs.js +0 -85
data/lib/wraith/javascript/snap.js +0 -85

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc02a9bdf3aceb57ec1790b0670454646ac9adbf
-  data.tar.gz: 4d9267de7cb2689b6bb01129fc4f25dbfd76c89e
+  metadata.gz: 7d0d54a5e957a901f42244cecc6523883865a91a
+  data.tar.gz: 94e209bfface9c61b060e3e9624d5cf9609a59ed
 SHA512:
-  metadata.gz: 883098ff0a08426b8532e29491580ad14ef854777acea133a3da71f25b442e92b65688718bea5e18c5d2db5caa6e4151706c1b29d3cf41eee4c55be0ed905cc1
-  data.tar.gz: 4899954af25ca0b3645dada0519c09c22a97547a6283fe674f67cf580438bf726f248c225b7cc0b5b8013336b4e6070ffc50f2cba8df5177a5b501dd3ccc61e4
+  metadata.gz: 21ff9b3f556c593da98bdd1bef23ad62b5d16898d8f38589cbf0eb1d4b1c9535a1e57e6bfd1f0bf32fda5207fc7ecbcf87a879c19e291d406e3f2731ee041a66
+  data.tar.gz: ff94dad2fb1d688a3fbebc110e27c234c656945e56db980a41f7570bd1a598aa05ff9eb520b87426efc2d75655109d78f0fc5da8f1138b65e036c72579285faa

data/README.md CHANGED Viewed

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://raw.githubusercontent.com/BBC-News/wraith/master/wraith-logo.png">
+  <img src="https://raw.githubusercontent.com/BBC-News/wraith/master/assets/wraith-logo.png">
 </p>
 <p align="center">

data/{wraith-logo.png → assets/wraith-logo.png} RENAMED Viewed

File without changes

data/lib/wraith/cli.rb CHANGED Viewed

@@ -19,15 +19,8 @@ class Wraith::CLI < Thor
   desc "setup", "creates config folder and default config"
   def setup
-    template("configs/templates/config.yaml", "configs/config.yaml")
-    template("lib/wraith/javascript/snap.js", "javascript/snap.js")
-  end
-  desc "setup_casper", "creates config folder and default config for casper"
-  def setup_casper
-    template("configs/templates/component.yaml", "configs/component.yaml")
-    template("lib/wraith/javascript/casper.js", "javascript/casper.js")
-    template("lib/wraith/javascript/beforeCapture.js", "javascript/beforeCapture.js")
+    directory("templates/configs", "configs")
+    directory("templates/javascript", "javascript")
   end
   desc "reset_shots [config_name]", "removes all the files in the shots folder"

data/lib/wraith/folder.rb CHANGED Viewed

@@ -34,7 +34,11 @@ class Wraith::FolderManager
   end
   def copy_old_shots
-    FileUtils.cp_r("#{dir}/.", "#{history_dir}/")
+    if history_dir.nil?
+      abort 'Error: no `history_dir` attribute found in config. Cannot copy files.'
+    else
+      FileUtils.cp_r("#{dir}/.", "#{history_dir}/")
+    end
   end
   def restore_shots

data/lib/wraith/gallery.rb CHANGED Viewed

@@ -50,7 +50,7 @@ class Wraith::GalleryGenerator
   def matcher(match, filename, dirname, category)
     @size = match[1].to_i
-    @group = match[2]
+    @group = get_group_from_match match
     @filepath = category + "/" + filename
     @thumbnail = "thumbnails/#{category}/#{filename}"
@@ -63,6 +63,16 @@ class Wraith::GalleryGenerator
     data_group(@group, size_dict, dirname, @filepath)
   end
+  def get_group_from_match(match)
+    group = match[2]
+    dash = match[2].rindex('-')
+    if !dash.nil?
+      group = match[2][dash+1..-1]
+    end
+    group
+  end
   def data_group(group, size_dict, dirname, filepath)
     case group
     when "diff"

data/lib/wraith/gallery_template/gallery_template.erb CHANGED Viewed

@@ -6,6 +6,9 @@
         .short-screenshot {
           max-width: 200px;
         }
+        .panel li{
+          word-wrap: break-word;
+        }
       </style>
     </head>
     <body>

data/lib/wraith/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "2.6.0"
+  VERSION = "2.7.0"
 end

data/lib/wraith/wraith.rb CHANGED Viewed

@@ -10,7 +10,7 @@ class Wraith::Wraith
       @config = YAML.load(File.open("configs/#{config_name}.yaml"))
     end
   rescue
-    puts "unable to find config"
+    puts "unable to find config at #{config_name}"
     exit 1
   end

data/{configs → spec/configs}/test_config--casper.yaml RENAMED Viewed

@@ -1,10 +1,15 @@
+##########
+### NB: the paths in this YAML config are relative to the root of the Wraith directory,
+### as `bundle exec rspec` is run from the root.
+##########
 #Headless browser option
 browser:
   phantomjs: "casperjs"
   # slimerjs: "slimerjs"
 #If you want to have multiple snapping files, set the file name here
-snap_file: "lib/wraith/javascript/casper.js"
+snap_file: "templates/javascript/casper.js"
 # Type the name of the directory that shots will be stored in
 directory: 'shots'

data/{configs/test_config.yaml → spec/configs/test_config--phantom.yaml} RENAMED Viewed

@@ -1,10 +1,15 @@
+##########
+### NB: the paths in this YAML config are relative to the root of the Wraith directory,
+### as `bundle exec rspec` is run from the root.
+##########
 #Headless browser option
 browser:
   phantomjs: "phantomjs"
   # slimerjs: "slimerjs"
 #If you want to have multiple snapping files, set the file name here
-snap_file: "lib/wraith/javascript/snap.js"
+snap_file: "templates/javascript/phantom.js"
 # Type the name of the directory that shots will be stored in
 directory: 'shots'

data/spec/helpers.rb CHANGED Viewed

@@ -15,8 +15,12 @@ end
 def run_js_then_capture(config)
   generated_image = 'shots/test/temporary_jsified_image.png'
-  saving.capture_page_image('casperjs', test_url1, 320, generated_image, selector, config[:global_js], config[:path_js])
+  saving.capture_page_image(config[:engine], test_url1, 320, generated_image, selector, config[:global_js], config[:path_js])
   Wraith::CompareImages.new(config_name).compare_task(generated_image, config[:output_should_look_like], diff_image, data_txt)
   diff = File.open('shots/test/test.txt', "rb").read
   expect(diff).to eq '0.0'
-end
+end
+def get_path_relative_to(current_file, file_to_find)
+  File.expand_path(File.join(File.dirname(current_file), file_to_find))
+end

data/spec/js/global.js CHANGED Viewed

@@ -1,5 +1,5 @@
-module.exports = function (casper) {
-    casper.evaluate(function () {
+module.exports = function (browserEngine) {
+    browserEngine.evaluate(function () {
         document.body.innerHTML = '&nbsp;';
         document.body.style['background-color'] = 'red';
     });

data/spec/js/path.js CHANGED Viewed

@@ -1,5 +1,5 @@
-module.exports = function (casper) {
-    casper.evaluate(function () {
+module.exports = function (browserEngine) {
+    browserEngine.evaluate(function () {
         document.body.innerHTML = '&nbsp;';
         document.body.style['background-color'] = 'green';
     });

data/spec/thumbnails/test/test_image-1.png ADDED Viewed

File without changes

data/spec/thumbnails/test/test_image-2.png ADDED Viewed

File without changes

data/spec/thumbnails/test/test_image-diff.png ADDED Viewed

File without changes

data/spec/wraith_spec.rb CHANGED Viewed

@@ -4,7 +4,7 @@ require "helpers"
 require "./lib/wraith/cli"
 describe Wraith do
-  let(:config_name) { "test_config" }
+  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" }
@@ -101,8 +101,40 @@ describe Wraith do
     end
   end
-  describe "When hooking into beforeCapture" do
-    let(:config_name) { "test_config--casper" }
+  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 => 'test/test_image-1.png',
+          :thumb    => 'thumbnails/test/test_image-1.png'
+        },
+        {
+          :filename => 'test/test_image-2.png',
+          :thumb    => 'thumbnails/test/test_image-2.png'
+        }
+      ]
+      dirs['test'][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 => 'test/test_image-diff.png',
+        :thumb    => 'thumbnails/test/test_image-diff.png'
+      }
+      expect(dirs['test'][0][:diff][:filename]).to eq 'test/test_image-diff.png'
+      expect(dirs['test'][0][:diff][:thumb]).to eq 'thumbnails/test/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" }
@@ -112,8 +144,9 @@ describe Wraith 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'
+        path_js:   'false',
+        output_should_look_like: 'spec/base/global.png',
+        engine:    'casperjs'
       )
     end
@@ -121,7 +154,8 @@ describe Wraith do
       run_js_then_capture(
         global_js: 'false',
         path_js: before_capture_js,
-        output_should_look_like: 'spec/base/path.png'
+        output_should_look_like: 'spec/base/path.png',
+        engine:    'casperjs'
       )
     end
@@ -129,9 +163,47 @@ describe Wraith do
       run_js_then_capture(
         global_js: before_suite_js,
         path_js: before_capture_js,
-        output_should_look_like: 'spec/base/path.png'
+        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/templates/README.md ADDED Viewed

@@ -0,0 +1,5 @@
+Everything in this directory (with the exception of this README) gets copied to the user's project when they run `wraith setup`.
+The idea is that the user can run any of these as an example, e.g. `wraith capture configs/component.yaml`.
+The configs and javascript are set up on the assumption that they are called from the directory above.

data/templates/configs/component.yaml ADDED Viewed

@@ -0,0 +1,58 @@
+# Add as many domains as necessary. Key will act as a label
+domains:
+  english: "http://www.bbc.co.uk"
+# (optional) JavaScript file to execute before taking screenshot of every path.
+# Can be used to reload current page with headers specified, or to dynamically
+# AJAX in content, or all manner of other uses!
+#before_capture: 'javascript/global.js'
+# Type page URL paths below, here are a couple of examples
+paths:
+  clickable_guide:
+    path: /news/entertainment-arts-27221191
+    selector: '.idt__news' # selector to take a screenshot of
+  clickable_guide__after_click:
+    path: /news/entertainment-arts-27221191
+    selector: '.idt__news'
+    # (optional) JavaScript file to execute before taking the screenshot of this path.
+    # This is always executed AFTER the 'global' before_capture hook toward the top of this file.
+    before_capture: 'javascript/beforeCapture--casper_example.js'
+# amount of fuzz ImageMagick will use when comparing images. A higher fuzz makes the comparison less strict.
+fuzz: '20%'
+# the maximum acceptable level of difference (in %) between two images.
+# Wraith considers it a failure if an image diff goes above this threshold.
+threshold: 5
+# screen widths (and optional height) to resize the browser to before taking the screenshot
+screen_widths:
+  - 320
+  - 600x768
+  - 768
+  - 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/casper.js"
+# the directory that your base screenshots will be stored in
+history_dir: 'shots_base'
+# the directory that your latest screenshots will be stored in
+directory: 'shots'
+# choose how results are displayed in the gallery (default is `alphanumeric` if omitted)
+# Different screen widths are always grouped together.
+# Options:
+#   alphanumeric - all paths (with or without a difference) are shown, sorted by path
+#   diffs_first - all paths (with or without a difference) are shown, sorted by difference size (largest first)
+#   diffs_only - only paths with a difference are shown, sorted by difference size (largest first)
+mode: alphanumeric

data/templates/configs/multiple_domains.yaml ADDED Viewed

@@ -0,0 +1,54 @@
+# Add as many domains as necessary. Key will act as a label
+domains:
+  arabic:  "http://www.bbc.com/arabic"
+  persian: "http://www.bbc.com/persian"
+  russian: "http://www.bbc.com/russian"
+# (optional) JavaScript file to execute before taking screenshot of every path.
+# Can be used to reload current page with headers specified, or to dynamically
+# AJAX in content, or all manner of other uses!
+#before_capture: 'javascript/global.js'
+# Type page URL paths below, here are a couple of examples.
+# They should exist for all of the domains you've specified above.
+paths:
+  home: /
+  interactivity: /interactivity
+# amount of fuzz ImageMagick will use when comparing images. A higher fuzz makes the comparison less strict.
+fuzz: '20%'
+# the maximum acceptable level of difference (in %) between two images.
+# Wraith considers it a failure if an image diff goes above this threshold.
+threshold: 5
+# screen widths (and optional height) to resize the browser to before taking the screenshot
+screen_widths:
+  - 320
+  - 600x768
+  - 768
+  - 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 directory that your base screenshots will be stored in
+history_dir: 'shots_base'
+# the directory that your latest screenshots will be stored in
+directory: 'shots'
+# choose how results are displayed in the gallery (default is `alphanumeric` if omitted)
+# Different screen widths are always grouped together.
+# Options:
+#   alphanumeric - all paths (with or without a difference) are shown, sorted by path
+#   diffs_first - all paths (with or without a difference) are shown, sorted by difference size (largest first)
+#   diffs_only - only paths with a difference are shown, sorted by difference size (largest first)
+mode: diffs_first

data/templates/configs/spider.yaml ADDED Viewed

@@ -0,0 +1,54 @@
+# Add as many domains as necessary. Key will act as a label
+domains:
+  my_site:  "http://www.example.com"
+# 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
+spider_file: example_com_spider.txt
+# 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%'
+# the maximum acceptable level of difference (in %) between two images.
+# Wraith considers it a failure if an image diff goes above this threshold.
+threshold: 5
+# screen widths (and optional height) to resize the browser to before taking the screenshot
+screen_widths:
+  - 320
+  - 600x768
+  - 768
+  - 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.js"
+# the directory that your latest screenshots will be stored in
+directory: 'shots_nojs'
+# choose how results are displayed in the gallery (default is `alphanumeric` if omitted)
+# Different screen widths are always grouped together.
+# Options:
+#   alphanumeric - all paths (with or without a difference) are shown, sorted by path
+#   diffs_first - all paths (with or without a difference) are shown, sorted by difference size (largest first)
+#   diffs_only - only paths with a difference are shown, sorted by difference size (largest first)
+mode: diffs_first