wraith 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b91a9e01056e5ee44ce5a8726152a023023285f
-  data.tar.gz: 3043cc0f99e7dedee6c0878f09e41ff71f042923
+  metadata.gz: acbb02d7ef9a06d124b77534e5976fb5e3f23378
+  data.tar.gz: 69ca8a5ce320a2ece935d527a6512fdf47b4df8b
 SHA512:
-  metadata.gz: e0ea6720ac947da1b0ad1fda376fa288ae3ea58953c8b5cb239b22e08e410df49fd6f89ca8cd3bcd546148c413a29a16de4b7f65dd1a2eb7b10ecf3739a3830a
-  data.tar.gz: ccec5c11e607f1c3faf657edff070cfff0ba61b6641b135e7f97078290d452a34f0f808ec936ecdc525e08a65d2156cc1b0540aa527f29e6057e445b81076cb0
+  metadata.gz: 1c4892a2d3a69ed520c17ea82d2e5e79b045eb1c9bbcfcb7fa7e519484f645132163e577d78b3e7137dee5fa59f57a71434888a08727e9b3ccb566279106dad5
+  data.tar.gz: bf101e7b2b614d183dfdb2743674c23fb27e6e806240577aee535b8bd0905414e6fd2119eb51c35bd1373ff9bf6b8757fe79a4579d26d59870ec78c82f7fd31f

data/README.md

@@ -64,12 +64,11 @@ Open terminal and run
 
     gem install wraith
 
-You can then run the following inside the Wraith directory to create a template snap.js and config file:
+You can then run the following to create a template snap.js and config file:
     
-    gem setup
+    wraith setup
 
-
-Alternatively you can download the install script via curl, this will not create a git repo though.    
+Alternatively you can clone the repo.    
     
     git clone https://github.com/BBC-News/wraith
     cd wraith
@@ -87,7 +86,7 @@ browser:
   # gecko: "slimerjs"
 
 # If you want to have multiple snapping files, set the file name here
-snap_file: "snap.js"
+snap_file: "path/to/snap.js"
 
 # Type the name of the directory that shots will be stored in
 directory:
@@ -136,8 +135,30 @@ phantomjs_options: "--ignore-ssl-errors=true"
 ```
 
 ## Using Wraith
+### Wraith Gem
+You can type `wraith` into terminal to bring up the list of commands, but the one to start Wraith is 
 
-If you are new to ruby, rake and PhantomJS, [here is a great screencast](http://www.youtube.com/watch?v=gE_19L0l2q0) about how to use Wraith by [Kevin Lamping](https://twitter.com/klamping)
+```sh
+wraith capture config_name
+```
+
+This assumes that your snap.js and config.yaml are in the folders that were created on setup.  There are other commands also available, these all expect a config_name to be passed as an option.  
+
+```sh
+  wraith capture config_name  # A full Wraith job
+  wraith compare_images       # compares images to generate diffs
+  wraith crop_images          # crops images to the same height
+  wraith folders              # create folders for images
+  wraith generate_gallery     # create page for viewing images
+  wraith generate_thumbnails  # create thumbnails for gallery
+  wraith reset_shots          # removes all the files in the shots folder
+  wraith save_images          # captures screenshots
+  wraith setup                # creates config folder and default config
+```
+
+### Wraith Rake tasks
+
+If you want to use the rake task instead of the gem, you can use the following.
 
 There are two ways of using Wraith, the fastest is to simply type rake.
 
@@ -154,6 +175,7 @@ rake config[config_name]
 On Windows before running the rake command you will need to make a small edit to the wraith.rb file.
 Locate lines 60 and 70 and switch the commenting as described.
 
+If you are new to ruby, rake and PhantomJS, [here is a great screencast](http://www.youtube.com/watch?v=gE_19L0l2q0) about how to use Wraith by [Kevin Lamping](https://twitter.com/klamping)
 
 ## Output
 
@@ -183,8 +205,8 @@ If you want to add functionality to this project, pull requests are welcome.
 
 **Please raise any issues with this project as a GitHub issue.**
 
-## Changelog - updated 24/01/14
-New features include some refactoring and the start of additional cli work.  We have removed the webdriver features for the time being, this will return in a more capable and fully feature state.
+## Changelog - updated 2014-02-09
+We have released Wraith as a Ruby Gem!!  There is a new CLI to better interact with Wraith and it's commands.
 
 ## License
 

data/Rakefile

@@ -8,16 +8,17 @@ require 'wraith/folder'
 require 'wraith/thumbnails'
 require 'wraith/compare_images'
 require 'wraith/images'
+require 'wraith/gallery'
 
 @config = ('config')
 
-task :grabber, [:yaml] do |t, custom|
+task :config, [:yaml] do |t, custom|
   custom.with_defaults(:yaml => "config")
   @config = "#{custom[:yaml]}"
-  Rake::Task["grab"].invoke
+  Rake::Task["default"].invoke
 end
 
-task :default => [:reset_shots_folder, :check_for_paths, :setup_folders, :save_images, :generate_thumbnails, :generate_gallery] do
+task :default => [:reset_shots_folder, :check_for_paths, :setup_folders, :save_images, :check_images, :crop_images, :compare_images, :generate_thumbnails, :generate_gallery] do
   puts 'Done!';
 end
 
@@ -47,12 +48,12 @@ task :save_images do
 end
 
 task :crop_images do
-  crop = Wraith::CropImages.new(@save_images.directory)
+  crop = Wraith::CropImages.new(@config)
   crop.crop_images
 end
 
 task :check_images do
-  image = Wraith::Images.new(@save_images.directory)
+  image = Wraith::Images.new(@config)
   image.files
 end
 
@@ -62,7 +63,16 @@ task :generate_thumbnails do
 end
 
 task :generate_gallery do
-  sh "ruby lib/wraith/gallery.rb #{@save_images.directory}"
+  gallery = Wraith::GalleryGenerator.new(@config)
+  gallery.generate_gallery
 end
 
+task :grabber, [:yaml] do |t, custom|
+  custom.with_defaults(:yaml => "config")
+  @config = "#{custom[:yaml]}"
+  Rake::Task["grab"].invoke
+end
 
+task :grab => [:reset_shots_folder, :check_for_paths, :setup_folders, :save_images, :generate_thumbnails, :generate_gallery] do
+  puts 'Done!';
+end

data/lib/wraith/gallery_template/gallery_template.erb

@@ -37,7 +37,7 @@
                                 <h3 class="col-lg-1 text-muted"><%=size%>px</h3>
                                 <% files[:variants].each do |file| %>
                                     <div class="col-lg-3">
-                                        <a href="<%=path%>/<%=file[:filename]%>">
+                                        <a href="<%=file[:filename]%>">
                                             <img class="short-screenshot img-thumbnail" src="<%=path%><%=file[:thumb]%>">
                                         </a>
                                         <p class="text-center"><%=file[:name]%></p>
@@ -45,7 +45,7 @@
                                 <% end %>
                                 <div class="col-lg-3">
                                     <% if files[:diff] %>
-                                        <a href="<%=path%>/<%=files[:diff][:filename]%>">
+                                        <a href="<%=files[:diff][:filename]%>">
                                             <img class="short-screenshot img-thumbnail" src="<%=path%><%=files[:diff][:thumb]%>">
                                         </a>
                                     <% end %>

data/lib/wraith/version.rb

@@ -1,3 +1,3 @@
 module Wraith
-  VERSION = '1.1.2'
+  VERSION = '1.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wraith
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Dave Blooman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-08 00:00:00.000000000 Z
+date: 2014-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake