From bdf84255447c49b74bdf848d7f304044ff17f6b8 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Sun, 28 Feb 2016 18:50:06 +0000
Subject: [PATCH 01/33] updated version to 3.1.1

---
 lib/wraith/version.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index 3e585e42..4790c525 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

From dd474ad3ce57effd3961f0bbdd42824873144b31 Mon Sep 17 00:00:00 2001
From: Gordeev Sergey <gor08serg@ya.ru>
Date: Mon, 29 Feb 2016 22:54:03 +0300
Subject: [PATCH 02/33] fix #395

---
 lib/wraith/wraith.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/wraith.rb b/lib/wraith/wraith.rb
index 746cf98f..16ff49c2 100644
--- a/lib/wraith/wraith.rb
+++ b/lib/wraith/wraith.rb
@@ -22,7 +22,7 @@ def open_config_file(config_name)
 
     possible_filenames.each do |filepath|
       if File.exist?(filepath)
-        config = File.open config_name
+        config = File.open filepath
         return YAML.load config
       end
     end

From ad36c28a3c44cbe9eee825e9246a276cde21e253 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 29 Feb 2016 22:07:43 +0000
Subject: [PATCH 03/33] fix #395

---
 lib/wraith/wraith.rb | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lib/wraith/wraith.rb b/lib/wraith/wraith.rb
index 746cf98f..d4044d94 100644
--- a/lib/wraith/wraith.rb
+++ b/lib/wraith/wraith.rb
@@ -22,12 +22,12 @@ def open_config_file(config_name)
 
     possible_filenames.each do |filepath|
       if File.exist?(filepath)
-        config = File.open config_name
+        config = File.open filepath
         return YAML.load config
       end
     end
   rescue
-    logger.error "unable to find config \"#{config}\""
+    logger.error "unable to find config \"#{config_name}\""
   end
 
   def directory

From fb9c67299f3ac569338698b40b9f6e5576473a5f Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 29 Feb 2016 22:08:39 +0000
Subject: [PATCH 04/33] incremented version

---
 lib/wraith/version.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index 4790c525..775ea936 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.1"
+  VERSION = "3.1.2"
 end

From cd4cfa648a882731ea358280cd5d9bfb5795b060 Mon Sep 17 00:00:00 2001
From: Kate Kligman <kate@katekligman.com>
Date: Thu, 10 Mar 2016 17:52:27 -0800
Subject: [PATCH 05/33] fix #397 - add version command

---
 lib/wraith/cli.rb | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/lib/wraith/cli.rb b/lib/wraith/cli.rb
index 0133049b..180d9674 100644
--- a/lib/wraith/cli.rb
+++ b/lib/wraith/cli.rb
@@ -176,4 +176,9 @@ def latest(config)
       generate_gallery(config)
     end
   end
+
+  desc "version", "Show the version of wraith"
+  def version
+    puts "Wraith version " + Wraith::VERSION
+  end
 end

From c6e64e13a96a2342e459ad9340b8c9034bd3ef98 Mon Sep 17 00:00:00 2001
From: Kate Kligman <kate@katekligman.com>
Date: Wed, 16 Mar 2016 17:00:37 -0700
Subject: [PATCH 06/33] Version command adjustments.

---
 lib/wraith/cli.rb | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/wraith/cli.rb b/lib/wraith/cli.rb
index 180d9674..7e529326 100644
--- a/lib/wraith/cli.rb
+++ b/lib/wraith/cli.rb
@@ -177,8 +177,9 @@ def latest(config)
     end
   end
 
-  desc "version", "Show the version of wraith"
+  desc "version", "Show the version of Wraith"
+  map ["--version", "-version", "-v"] => "version"
   def version
-    puts "Wraith version " + Wraith::VERSION
+    logger.info Wraith::VERSION
   end
 end

From c3ee92d40016a66a83c1ad772339c8b0b757dadb Mon Sep 17 00:00:00 2001
From: Kate Kligman <kate@katekligman.com>
Date: Tue, 29 Mar 2016 17:48:50 -0700
Subject: [PATCH 07/33] Fix #298 - use the latest version of ImageMagick with
 Docker

---
 Dockerfile | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Dockerfile b/Dockerfile
index 7c5204b5..46b3d5fc 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -17,4 +17,7 @@ RUN echo "deb http://security.debian.org/ jessie/updates contrib non-free" | tee
 RUN apt-get update
 RUN apt-get install -y ttf-freefont ttf-mscorefonts-installer ttf-bitstream-vera ttf-dejavu ttf-liberation
 
+# Make sure a recent (>6.7.7-10) version of ImageMagick is installed.
+RUN apt-get install -y imagemagick
+
 ENTRYPOINT [ "wraith" ]

From 1c87a639619f872b4befd3bc124a56116052ff70 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Fri, 8 Apr 2016 15:22:34 +0100
Subject: [PATCH 08/33] incremented to 3.1.3

---
 lib/wraith/version.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index 775ea936..5efcd9f0 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.2"
+  VERSION = "3.1.3"
 end

From bf5888c1697a36c5f2e7604c9a81dfe4193d2872 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Fri, 8 Apr 2016 15:25:22 +0100
Subject: [PATCH 09/33] fix #415

---
 lib/wraith/cli.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/cli.rb b/lib/wraith/cli.rb
index 7e529326..3d9333ed 100644
--- a/lib/wraith/cli.rb
+++ b/lib/wraith/cli.rb
@@ -42,7 +42,7 @@ def copy_old_shots(config_name)
     end
   end
 
-  desc "validate", "checks your configuration and validates that all required properties exist"
+  desc "validate [config_name]", "checks your configuration and validates that all required properties exist"
   def validate(config_name)
     within_acceptable_limits do
       logger.info Wraith::Validate.new(config_name).validate

From 1b31e4bf6b95b2a08cb4d09b2aaf816eb7ab6833 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Fri, 8 Apr 2016 15:28:06 +0100
Subject: [PATCH 10/33] incremented to v3.1.4

---
 lib/wraith/version.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index 5efcd9f0..bcda1698 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.3"
+  VERSION = "3.1.4"
 end

From 6b58c5616ec583c2fde48ecd1fe98851e4cd2af2 Mon Sep 17 00:00:00 2001
From: Mark Fox <markf@copiousinc.com>
Date: Sat, 16 Apr 2016 23:58:49 -0700
Subject: [PATCH 11/33] fixes #423

---
 lib/wraith/validate.rb | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/wraith/validate.rb b/lib/wraith/validate.rb
index bee74906..2aafa89e 100644
--- a/lib/wraith/validate.rb
+++ b/lib/wraith/validate.rb
@@ -45,6 +45,8 @@ def validate_mode_properties(mode)
   def validate_capture_mode
     fail InvalidDomainsError, "`wraith capture` requires exactly two domains. #{docs_prompt}" if wraith.domains.length != 2
 
+    fail MissingRequiredPropertyError, "You must specify a directory for capture! #{docs_prompt}" if wraith.directory.nil?
+    
     logger.warn "You have specified a `history_dir` in your config, but this is"\
                 " used in `history` mode, NOT `capture` mode. #{docs_prompt}" if wraith.history_dir
   end

From 871c29246961de676920e27a9f22973963c9f7dd Mon Sep 17 00:00:00 2001
From: Mark Fox <markf@copiousinc.com>
Date: Sun, 17 Apr 2016 00:20:05 -0700
Subject: [PATCH 12/33] update spec

---
 spec/validate_spec.rb | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/spec/validate_spec.rb b/spec/validate_spec.rb
index 9aad5a42..55b6c4d1 100644
--- a/spec/validate_spec.rb
+++ b/spec/validate_spec.rb
@@ -7,6 +7,8 @@
         test: http://www.bbc.com
 
       browser: "casperjs"
+
+      directory: some/dir
     ')
   end
 
@@ -47,6 +49,15 @@
       ')
       Wraith::Validate.new(config, true).validate("capture")
     end
+    
+    it "should fail if no directory is specified" do
+      config["domains"] = YAML.load('
+          test:  http://something.bbc.com
+          live:  http://www.bbc.com
+      ')
+      config["directory"] = nil
+      expect { Wraith::Validate.new(config, true).validate("capture") }.to raise_error MissingRequiredPropertyError
+    end
   end
 
   describe "validations specific to history mode" do

From bde0aadff23b160979adc0a8000ecc58650fc9c8 Mon Sep 17 00:00:00 2001
From: Pete Johns <pete.johns@envato.com>
Date: Mon, 18 Apr 2016 15:26:49 +1000
Subject: [PATCH 13/33] Allow newer nokogiris

---
 wraith.gemspec | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/wraith.gemspec b/wraith.gemspec
index e5231c90..28683c89 100644
--- a/wraith.gemspec
+++ b/wraith.gemspec
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'image_size'
   spec.add_runtime_dependency 'anemone'
   spec.add_runtime_dependency 'robotex'
-  spec.add_runtime_dependency 'nokogiri', '1.6.7'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6.7'
   spec.add_runtime_dependency 'log4r'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'parallel'

From e4dfba03a2900b6193763a6d57c0023eb0e8f5b2 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Fri, 22 Apr 2016 16:01:55 +0100
Subject: [PATCH 14/33] fix #405

---
 lib/wraith/helpers/custom_exceptions.rb | 3 +++
 lib/wraith/wraith.rb                    | 3 +--
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/lib/wraith/helpers/custom_exceptions.rb b/lib/wraith/helpers/custom_exceptions.rb
index 9431dc10..91dfd86d 100644
--- a/lib/wraith/helpers/custom_exceptions.rb
+++ b/lib/wraith/helpers/custom_exceptions.rb
@@ -6,3 +6,6 @@ class InvalidDomainsError < CustomError
 
 class MissingRequiredPropertyError < CustomError
 end
+
+class ConfigFileDoesNotExistError < CustomError
+end
diff --git a/lib/wraith/wraith.rb b/lib/wraith/wraith.rb
index d4044d94..a689dbf3 100644
--- a/lib/wraith/wraith.rb
+++ b/lib/wraith/wraith.rb
@@ -26,8 +26,7 @@ def open_config_file(config_name)
         return YAML.load config
       end
     end
-  rescue
-    logger.error "unable to find config \"#{config_name}\""
+    fail ConfigFileDoesNotExistError, "unable to find config \"#{config_name}\""
   end
 
   def directory

From b0995771b89df654d8a7bf952d051df49c97f5b9 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 25 Apr 2016 18:17:42 +0100
Subject: [PATCH 15/33] fix #419

---
 lib/wraith/gallery_template/slideshow_template.erb | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/wraith/gallery_template/slideshow_template.erb b/lib/wraith/gallery_template/slideshow_template.erb
index baead8e2..5f40c79c 100644
--- a/lib/wraith/gallery_template/slideshow_template.erb
+++ b/lib/wraith/gallery_template/slideshow_template.erb
@@ -109,7 +109,8 @@
   <script type="text/javascript">
     $(function() {
       $('.slideshow').cycle({
-        fx:     'cover',
+        fx:     'scrollHorz',
+        speed:  300,
         prev:   '.prev',
         next:   '.next',
         before: function (curr, next, opts) {

From 992de56f4a32584d14c8ed06e59268ea1616c8ca Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 25 Apr 2016 18:20:18 +0100
Subject: [PATCH 16/33] incremented to v3.1.5

---
 lib/wraith/version.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index bcda1698..45627dba 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.4"
+  VERSION = "3.1.5"
 end

From fe519eb840f3a00b5bc2b8729f9d89dc705843ff Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 25 Apr 2016 18:32:23 +0100
Subject: [PATCH 17/33] check for directory regardless of wraith mode

---
 lib/wraith/validate.rb | 14 ++++++--------
 lib/wraith/version.rb  |  2 +-
 2 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/lib/wraith/validate.rb b/lib/wraith/validate.rb
index 2aafa89e..2439dc32 100644
--- a/lib/wraith/validate.rb
+++ b/lib/wraith/validate.rb
@@ -19,12 +19,12 @@ def validate(mode = false)
   end
 
   def validate_basic_properties
-    if wraith.engine.nil?
-      fail MissingRequiredPropertyError, "You must specify a browser engine! #{docs_prompt}"
-    end
-    unless wraith.domains
-      fail MissingRequiredPropertyError, "You must specify at least one domain for Wraith to do anything! #{docs_prompt}"
-    end
+    fail MissingRequiredPropertyError, "You must specify a browser engine! #{docs_prompt}" if wraith.engine.nil?
+
+    fail MissingRequiredPropertyError, "You must specify at least one domain for Wraith to do anything! #{docs_prompt}" unless wraith.domains
+
+    fail MissingRequiredPropertyError, "You must specify a directory for capture! #{docs_prompt}" if wraith.directory.nil?
+
     # @TODO validate fuzz is not nil, etc
   end
 
@@ -45,8 +45,6 @@ def validate_mode_properties(mode)
   def validate_capture_mode
     fail InvalidDomainsError, "`wraith capture` requires exactly two domains. #{docs_prompt}" if wraith.domains.length != 2
 
-    fail MissingRequiredPropertyError, "You must specify a directory for capture! #{docs_prompt}" if wraith.directory.nil?
-    
     logger.warn "You have specified a `history_dir` in your config, but this is"\
                 " used in `history` mode, NOT `capture` mode. #{docs_prompt}" if wraith.history_dir
   end
diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index 45627dba..503a00bd 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.5"
+  VERSION = "3.1.6"
 end

From 25757a1729a8afc8883988bf9d1bd032bd98fbb9 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 13:39:51 +0100
Subject: [PATCH 18/33] added test

---
 spec/validate_spec.rb | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/spec/validate_spec.rb b/spec/validate_spec.rb
index 9aad5a42..b63ba529 100644
--- a/spec/validate_spec.rb
+++ b/spec/validate_spec.rb
@@ -24,6 +24,10 @@
       config["browser"] = nil
       expect { Wraith::Validate.new(config, true).validate }.to raise_error MissingRequiredPropertyError
     end
+
+    it "should complain if the config file doesn't exist" do
+      expect { Wraith::Wraith.new('configs/some_made_up_config.yml') }.to raise_error ConfigFileDoesNotExistError
+    end
   end
 
   describe "validation specific to capture mode" do

From 395c3e70e1a0096af0d9f3d33026bfd8f10d20ee Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 13:41:47 +0100
Subject: [PATCH 19/33] incremented to 3.1.7

---
 lib/wraith/version.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index bcda1698..601129c0 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.4"
+  VERSION = "3.1.7"
 end

From 15f7ece7bc20ff92bac2435ade002bb41cd2fb97 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 14:02:56 +0100
Subject: [PATCH 20/33] fix #430

---
 lib/wraith/validate.rb | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/wraith/validate.rb b/lib/wraith/validate.rb
index 2439dc32..e448deda 100644
--- a/lib/wraith/validate.rb
+++ b/lib/wraith/validate.rb
@@ -68,12 +68,14 @@ def docs_prompt
 
   def list_debug_information
     wraith_version      = Wraith::VERSION
+    command_run         = ARGV.join ' '
     ruby_version        = run_command_safely("ruby -v") || "Ruby not installed"
     phantomjs_version   = run_command_safely("phantomjs --version") || "PhantomJS not installed"
     casperjs_version    = run_command_safely("casperjs --version") || "CasperJS not installed"
     imagemagick_version = run_command_safely("convert -version") || "ImageMagick not installed"
 
     logger.debug "#################################################"
+    logger.debug "  Command run:        #{command_run}"
     logger.debug "  Wraith version:     #{wraith_version}"
     logger.debug "  Ruby version:       #{ruby_version}"
     logger.debug "  ImageMagick:        #{imagemagick_version}"

From 342bc04bfe37c7c76d605b302487168efefd3b05 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 14:18:47 +0100
Subject: [PATCH 21/33] added issue templates and contributing guidelines

---
 .github/CONTRIBUTING.md   |  9 +++++++++
 .github/ISSUE_TEMPLATE.md | 21 +++++++++++++++++++++
 2 files changed, 30 insertions(+)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/ISSUE_TEMPLATE.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 00000000..f19fac2f
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+We're always happy to receive Pull Requests from the Wraith community.
+
+Guidelines:
+
+* Make sure your PR is documented (What does it do? Why is it needed?)
+* New features and bug fixes should have tests written alongside them
+* Appreciate that contributors maintain Wraith in their spare time, so a response may take several weeks
+
+A PR is more likely to be merged if it fixes one of [Wraith's open issues](https://github.com/BBC-News/wraith/issues).
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..06c3e8d2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,21 @@
+
+
+
+------
+Reporting a problem? Please describe the issue above, and complete the following checklist so that we can help you more quickly.
+
+#### Issue checklist:
+
+[ ] I have validated my config file against [YAML Validator](http://codebeautify.org/yaml-validator) to make sure it is valid YAML.
+
+[ ] I have run the command in verbose mode (by adding `verbose: true` to my config) and pasted the output below:
+
+```
+paste results here
+```
+
+[ ] I have pasted the contents of my config file below:
+
+```
+paste config here
+```

From 0aa80851210f83279622156c44ed04a0f02cccf4 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 14:21:53 +0100
Subject: [PATCH 22/33] moved contributing instructions from readme to
 dedicated template

---
 .github/CONTRIBUTING.md | 12 ++++++++++++
 README.md               | 12 +-----------
 2 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index f19fac2f..956b00aa 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -7,3 +7,15 @@ Guidelines:
 * Appreciate that contributors maintain Wraith in their spare time, so a response may take several weeks
 
 A PR is more likely to be merged if it fixes one of [Wraith's open issues](https://github.com/BBC-News/wraith/issues).
+
+How to contribute:
+
+* Fork a branch based off BBC-News/wraith:master and do all of your changes within it.
+* Make commits of logical units and describe them properly.
+* Check for unnecessary whitespace with git diff --check before committing.
+* If possible, submit tests to your patch / new feature so it can be tested easily.
+* Assure nothing is broken by running all the tests (`bundle exec rspec`).
+* Please ensure that it complies with coding standards.
+* When writing the title of your Pull Request, if you have to pause to add an 'and' anywhere in the title - it should be two pull requests.
+
+**Please raise any issues with this project as a GitHub issue.**
diff --git a/README.md b/README.md
index b5a3dd19..5a732356 100644
--- a/README.md
+++ b/README.md
@@ -56,17 +56,7 @@ Wraith also requires at least one of these headless browsers:
 
 ## Contributing
 
-If you want to add functionality to this project, pull requests are welcome.
-
- * Fork a branch based off BBC-News/wraith:master and do all of your changes within it.
- * Make commits of logical units and describe them properly.
- * Check for unnecessary whitespace with git diff --check before committing.
- * If possible, submit tests to your patch / new feature so it can be tested easily.
- * Assure nothing is broken by running all the tests (`bundle exec rspec`).
- * Please ensure that it complies with coding standards.
- * When writing the title of your Pull Request, if you have to pause to add an 'and' anywhere in the title - it should be two pull requests.
-
-**Please raise any issues with this project as a GitHub issue.**
+Please read [how to contribute to Wraith](https://github.com/BBC-News/wraith/blob/master/.github/CONTRIBUTING.md).
 
 ## License
 

From b6ea4bd8ca7a4c655a8e94ba1c1d2ef362e89787 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 14:22:34 +0100
Subject: [PATCH 23/33] use checkboxes

---
 .github/ISSUE_TEMPLATE.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 06c3e8d2..4945c1d8 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -6,15 +6,15 @@ Reporting a problem? Please describe the issue above, and complete the following
 
 #### Issue checklist:
 
-[ ] I have validated my config file against [YAML Validator](http://codebeautify.org/yaml-validator) to make sure it is valid YAML.
+- [ ] I have validated my config file against [YAML Validator](http://codebeautify.org/yaml-validator) to make sure it is valid YAML.
 
-[ ] I have run the command in verbose mode (by adding `verbose: true` to my config) and pasted the output below:
+- [ ] I have run the command in verbose mode (by adding `verbose: true` to my config) and pasted the output below:
 
 ```
 paste results here
 ```
 
-[ ] I have pasted the contents of my config file below:
+- [ ] I have pasted the contents of my config file below:
 
 ```
 paste config here

From 9ba5e1dd7ce1ec3ccde6617c23b125a9d2152f5c Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 15:15:52 +0100
Subject: [PATCH 24/33] fix #377

---
 lib/wraith/folder.rb                    |  7 ++-----
 lib/wraith/gallery.rb                   | 23 +++++++++++++++++++++--
 lib/wraith/helpers/custom_exceptions.rb |  8 ++++++++
 3 files changed, 31 insertions(+), 7 deletions(-)

diff --git a/lib/wraith/folder.rb b/lib/wraith/folder.rb
index 41f335c3..8951c209 100644
--- a/lib/wraith/folder.rb
+++ b/lib/wraith/folder.rb
@@ -86,11 +86,8 @@ def threshold_rate(dirs)
     dirs.each do |_folder_name, shot_info|
       shot_info.each do |_k, v|
         begin
-          if !v.include?(:diff)
-            return false
-          elsif v[:data] > wraith.threshold
-            return false
-          end
+          return false unless v.include?(:diff)
+          return false if v[:data] > wraith.threshold
         rescue
           return true
         end
diff --git a/lib/wraith/gallery.rb b/lib/wraith/gallery.rb
index 4e4b893f..b764dc9a 100755
--- a/lib/wraith/gallery.rb
+++ b/lib/wraith/gallery.rb
@@ -111,13 +111,32 @@ def data_check(size_dict, dirname, filepath)
 
   def sorting_dirs(dirs)
     if %w(diffs_only diffs_first).include?(wraith.mode)
-      @sorted = dirs.sort_by { |_category, sizes| -1 * sizes.max_by { |_size, dict| dict[:data] }[1][:data] }
+      @sorted = sort_by_diffs dirs
     else
-      @sorted = dirs.sort_by { |category, _sizes| category }
+      @sorted = sort_alphabetically dirs
     end
     Hash[@sorted]
   end
 
+  def sort_by_diffs(dirs)
+    dirs.sort_by do |_category, sizes|
+      size = select_size_with_biggest_diff sizes
+      -1 * size[1][:data]
+    end
+  end
+
+  def select_size_with_biggest_diff(sizes)
+    begin
+      sizes.max_by { |_size, dict| dict[:data] }
+    rescue
+      fail MissingImageError
+    end
+  end
+
+  def sort_alphabetically(dirs)
+    dirs.sort_by { |category, _sizes| category }
+  end
+
   def generate_gallery(with_path = "")
     dest = "#{@location}/gallery.html"
     directories = parse_directories(@location)
diff --git a/lib/wraith/helpers/custom_exceptions.rb b/lib/wraith/helpers/custom_exceptions.rb
index 91dfd86d..52b6d5db 100644
--- a/lib/wraith/helpers/custom_exceptions.rb
+++ b/lib/wraith/helpers/custom_exceptions.rb
@@ -9,3 +9,11 @@ class MissingRequiredPropertyError < CustomError
 
 class ConfigFileDoesNotExistError < CustomError
 end
+
+class MissingImageError < CustomError
+  def initialize(msg = false)
+    default_msg = "Something went wrong! It looks like you're missing some images. Check your output directory and make sure that each path has four files for every screen size (data.txt, diff, base, latest). If in doubt, delete your output directory and run Wraith again."
+    msg = default_msg unless msg
+    super(msg)
+  end
+end

From 751fc02f1bddb871715a8b6dfb647811beb612e8 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 16:42:17 +0100
Subject: [PATCH 25/33] incremented to v3.1.8

---
 lib/wraith/version.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index 601129c0..4e57719d 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.7"
+  VERSION = "3.1.8"
 end

From d4833b7bdbd13068009d4582cc7c48a866c9cd8d Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 17:27:57 +0100
Subject: [PATCH 26/33] removed casperjs from the wraith gem dependencies

a) casperjs isn't necessarily a dependency. Some people only use PhantomJS
b) this is causing issues when we try to upgrade to phantomjs 2.x, which requires casperjs beta 1.1. By listing casperjs as a dependency inside the Wraith gemspec, we're installing the default version of casperjs available to Rubygems, and this becomes the casperjs executable even if we've installed casperjs through something like brew. Consequently, we're stuck with an outdated version of casperjs and that prevents us from moving to phantomjs 2.

We should trust developers to sort out their own phantom/casper dependencies/configurations.
---
 lib/wraith/version.rb | 2 +-
 wraith.gemspec        | 1 -
 2 files changed, 1 insertion(+), 2 deletions(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index 4e57719d..2552916c 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.8"
+  VERSION = "3.1.9"
 end
diff --git a/wraith.gemspec b/wraith.gemspec
index 28683c89..9e29800d 100644
--- a/wraith.gemspec
+++ b/wraith.gemspec
@@ -29,5 +29,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'log4r'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'parallel'
-  spec.add_runtime_dependency 'casperjs'
 end

From e88224505274e6aeb40176192675cb81eb846679 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 17:30:54 +0100
Subject: [PATCH 27/33] add casperjs as a developer dependency

---
 wraith.gemspec | 1 +
 1 file changed, 1 insertion(+)

diff --git a/wraith.gemspec b/wraith.gemspec
index 9e29800d..072c302c 100644
--- a/wraith.gemspec
+++ b/wraith.gemspec
@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'casperjs'
 
   spec.add_runtime_dependency 'rake'
   spec.add_runtime_dependency 'image_size'

From ff306ffad62a8c031296620a5a006b13a9005b5d Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 17:35:05 +0100
Subject: [PATCH 28/33] incremented to v3.2.0

---
 lib/wraith/version.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index 2552916c..40b96e61 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.1.9"
+  VERSION = "3.2.0"
 end

From 2d3e7f117890c211945b8f374a7f2823cbc6c9c9 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Mon, 16 May 2016 17:53:51 +0100
Subject: [PATCH 29/33] fix #366

---
 spec/before_capture_spec.rb    | 4 ++--
 templates/configs/history.yaml | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/spec/before_capture_spec.rb b/spec/before_capture_spec.rb
index 19cc9ea8..58240fc9 100644
--- a/spec/before_capture_spec.rb
+++ b/spec/before_capture_spec.rb
@@ -45,7 +45,7 @@ def run_js_then_capture(config)
 
   # @TODO - we need tests determining the path to "path-level before_capture hooks"
 
-  describe "When hooking into beforeCapture (CasperJS)" do
+  describe "When hooking into before_capture (CasperJS)" do
     it "Executes the global JS before capturing" do
       run_js_then_capture(
         :global_js               => before_suite_js,
@@ -75,7 +75,7 @@ def run_js_then_capture(config)
   end
 
   #  @TODO - uncomment and figure out why broken
-  # describe "When hooking into beforeCapture (PhantomJS)" do
+  # describe "When hooking into before_capture (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) }
diff --git a/templates/configs/history.yaml b/templates/configs/history.yaml
index a49a2afe..aaa81eaf 100644
--- a/templates/configs/history.yaml
+++ b/templates/configs/history.yaml
@@ -29,7 +29,7 @@ paths:
   clickable_guide__after_click:
     path: /news/entertainment-arts-27221191
     selector: '.idt__news'
-    before_capture: 'javascript/beforeCapture--casper_example.js' # (optional) JavaScript file to execute before taking the screenshot of this path.
+    before_capture: 'javascript/interact--casper.js' # (optional) JavaScript file to execute before taking the screenshot of this path.
 
 # (optional) JavaScript file to execute before taking screenshot of every path. Default: nil
 before_capture: 'javascript/wait--casper.js'

From d8e6aaedf1ad95f7b1f8992207f475da9cd23202 Mon Sep 17 00:00:00 2001
From: Punit Shah <punit.shah@bbc.co.uk>
Date: Fri, 20 May 2016 16:24:52 +0100
Subject: [PATCH 30/33] updated dockerfile to install the new phantomjs and
 casperjs

---
 Dockerfile | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Dockerfile b/Dockerfile
index 46b3d5fc..bc5a4ee5 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -3,11 +3,11 @@ FROM ruby:2.1.2
 # some of ruby's build scripts are written in ruby
 # we purge this later to make sure our final image uses what we just built
 RUN apt-get update
-RUN curl -o phantomjs.tar.gz -L https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.8-linux-x86_64.tar.bz2
-RUN tar -xvf phantomjs.tar.gz
-RUN mv phantomjs-1.9.8-linux-x86_64/bin/phantomjs /usr/bin
 RUN echo "export phantomjs=/usr/bin/phantomjs" > .bashrc
-RUN apt-get install -y libfreetype6 libfontconfig1
+RUN apt-get install -y libfreetype6 libfontconfig1 nodejs npm
+RUN ln -s /usr/bin/nodejs /usr/bin/node
+RUN npm install npm
+RUN npm install -g phantomjs@2.1.7 casperjs@1.1.1
 RUN gem install wraith --no-rdoc --no-ri
 RUN gem install aws-sdk --no-rdoc --no-ri
 

From 1099b6e61543627b83376f2b71f709893fa1f79c Mon Sep 17 00:00:00 2001
From: Dominique Kreemers <dominique.kreemers@me.com>
Date: Wed, 13 Jul 2016 10:01:11 +0200
Subject: [PATCH 31/33] Add attr_reader to Wraith::Spider to fix error
 "undefined local variable or method `wraith'"

resolves #401, #422
---
 lib/wraith/spider.rb | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/wraith/spider.rb b/lib/wraith/spider.rb
index 3ed65f10..76317c3f 100644
--- a/lib/wraith/spider.rb
+++ b/lib/wraith/spider.rb
@@ -27,6 +27,8 @@ def check_for_paths
 end
 
 class Wraith::Spider
+  attr_reader :wraith
+
   def initialize(wraith)
     @wraith = wraith
     @paths = {}

From 2f237193d16cc6a987516cd35144af8b6644eef5 Mon Sep 17 00:00:00 2001
From: ChrisBAshton <chrisashtonweb@gmail.com>
Date: Thu, 4 Aug 2016 16:41:07 +0100
Subject: [PATCH 32/33] bump to v3.2.1

---
 lib/wraith/version.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/wraith/version.rb b/lib/wraith/version.rb
index 40b96e61..4e606a07 100644
--- a/lib/wraith/version.rb
+++ b/lib/wraith/version.rb
@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = "3.2.0"
+  VERSION = "3.2.1"
 end

From ee569d71c542a3bb45fb3b82598f145a9dbef30c Mon Sep 17 00:00:00 2001
From: Viktor Fonic <viktor.fonic@gmail.com>
Date: Wed, 16 Nov 2016 13:41:47 +0700
Subject: [PATCH 33/33] Use left/right arrow keys for changing to next/prev
 gallery slide

---
 lib/wraith/gallery_template/slideshow_template.erb | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/lib/wraith/gallery_template/slideshow_template.erb b/lib/wraith/gallery_template/slideshow_template.erb
index 5f40c79c..8d1a3d90 100644
--- a/lib/wraith/gallery_template/slideshow_template.erb
+++ b/lib/wraith/gallery_template/slideshow_template.erb
@@ -148,6 +148,20 @@
           $(this).remove();
         })
       })
+
+      window.addEventListener('keydown', function(e){
+        var leftArrowKeyCode = 37;
+        var rightArrowKeyCode = 39;
+
+        e = e || window.event;
+
+        if (e.keyCode === leftArrowKeyCode) {
+           $('.slideshow').cycle('prev');
+        }
+        else if (e.keyCode === rightArrowKeyCode) {
+           $('.slideshow').cycle('next');
+        }
+      });
     })
 </script>
 </head>