wraith 1.0.0 → 1.1.1

data/bin/wraith

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler/setup'
+
+begin
+  require 'wraith/cli'
+  Wraith::CLI.start
+rescue Interrupt => e
+  puts "\nQuitting..."
+  exit 1
+rescue SystemExit => e
+  exit e.status
+end

data/configs/config.yaml

@@ -0,0 +1,43 @@
+#Headless browser option
+browser:
+  webkit: "phantomjs"
+  # gecko: "slimerjs"
+
+#If you want to have multiple snapping files, set the file name here
+snap_file: "lib/wraith/javascript/snap.js"
+
+# Type the name of the directory that shots will be stored in
+directory:
+  - 'shots'
+
+# Add only 2 domains, key will act as a label
+domains:
+  english: "http://www.live.bbc.co.uk/news"
+  russian: "http://www.live.bbc.co.uk/russian"
+
+#Type screen widths below, here are a couple of examples
+screen_widths:
+  - 320
+  - 600
+  - 768
+  - 1024
+  - 1280
+
+#Type page URL paths below, here are a couple of examples
+paths:
+  home: /
+  uk_index: /uk
+
+# If you don't want to name the paths explicitly you can use a yaml
+# collection as follows, and names will be derived by replacing / with _
+#
+# paths:
+#  - /imghp
+#  - /maps
+
+#Amount of fuzz ImageMagick will use
+fuzz: '20%'
+
+#Set the number of days to keep the site spider file
+spider_days:
+  - 10

data/configs/config_nojs.yaml

@@ -0,0 +1,43 @@
+#Headless browser option
+browser:
+  webkit: "phantomjs"
+  # gecko: "slimerjs"
+
+#If you want to have multiple snapping files, set the file name here
+snap_file: "lib/wraith/javascript/nojs.js"
+
+# Type the name of the directory that shots will be stored in
+directory:
+  - 'shots_nojs'
+
+# Add only 2 domains, key will act as a label
+domains:
+  english: "http://www.live.bbc.co.uk/news"
+  russian: "http://www.live.bbc.co.uk/russian"
+
+#Type screen widths below, here are a couple of examples
+screen_widths:
+  - 320
+  - 600
+  - 768
+  - 1024
+  - 1280
+
+#Type page URL paths below, here are a couple of examples
+paths:
+  home: /
+  uk_index: /uk
+
+# If you don't want to name the paths explicitly you can use a yaml
+# collection as follows, and names will be derived by replacing / with _
+#
+# paths:
+#  - /imghp
+#  - /maps
+
+#Amount of fuzz ImageMagick will use 
+fuzz: '20%' 
+
+#Set the number of days to keep the site spider file
+spider_days:
+  - 10

data/configs/test_config.yaml

@@ -0,0 +1,40 @@
+#Headless browser option
+browser:
+  webkit: "phantomjs"
+  # gecko: "./slimerjs"
+
+#If you want to have multiple snapping files, set the file name here
+snap_file: "lib/wraith/javascript/snap.js"
+
+# Type the name of the directory that shots will be stored in
+directory:
+  - 'shots'
+
+# Add only 2 domains, key will act as a label
+domains:
+  english: "http://www.live.bbc.co.uk/news"
+  russian: "http://www.live.bbc.co.uk/russian"
+
+#Type screen widths below, here are a couple of examples
+screen_widths:
+  - 320
+  - 600
+  - 768
+  - 1024
+  - 1280
+
+#Type page URL paths below, here are a couple of examples
+paths:
+  home: /
+  uk_index: /uk
+
+# If you don't want to name the paths explicitly you can use a yaml
+# collection as follows, and names will be derived by replacing / with _
+#
+# paths:
+#  - /imghp
+#  - /maps
+
+#Amount of fuzz ImageMagick will use 
+fuzz: '20%' 
+

data/lib/wraith.rb

@@ -1,5 +1,6 @@
-class Wraith
-  def self.hi
-    puts "Hello world!"
-  end
+require "wraith/version"
+
+module Wraith
+  autoload :CLI, 'wraith/cli'
+  autoload :Error, 'wraith/error'
 end

data/lib/wraith/cli.rb

@@ -0,0 +1,82 @@
+require 'thor'
+require 'wraith'
+require 'wraith/save_images'
+require 'wraith/crop'
+require 'wraith/spider'
+require 'wraith/folder'
+require 'wraith/thumbnails'
+require 'wraith/compare_images'
+require 'wraith/images'
+
+class Wraith::CLI < Thor
+
+  attr_accessor :config_name
+
+  desc "reset_shots", "removes all the files in the shots folder"
+  def reset_shots(config_name)
+    reset = Wraith::FolderManager.new(config_name)
+    reset.clear_shots_folder
+  end
+
+  desc "setup_folders", "create folders for images"
+  def setup_folders(config_name)
+    create = Wraith::FolderManager.new(config_name)
+    create.create_folders
+  end
+
+  no_commands do  
+    def check_for_paths(config_name)
+      spider = Wraith::Spidering.new(config_name)
+      spider.check_for_paths
+    end
+
+    def check_images(config_name)
+      image = Wraith::Images.new(config_name)
+      image.files
+    end
+  end
+
+  desc "save_images", "captures screenshots"
+  def save_images(config_name)
+    save_images = Wraith::SaveImages.new(config_name)
+    save_images.save_images
+  end
+
+  desc "crop_images", "crops images to the same height"
+  def crop_images(config_name)
+    crop = Wraith::CropImages.new(config_name)
+    crop.crop_images
+  end
+
+  desc "compare_images", "compares images to generate diffs"
+  def compare_images(config_name)
+    compare = Wraith::CompareImages.new(config_name)
+    compare.compare_images
+  end
+
+  desc "generate_thumbnails", "create thumbnails for gallery"
+  def generate_thumbnails(config_name)
+    thumbs = Wraith::Thumbnails.new(config_name)
+    thumbs.generate_thumbnails
+  end
+
+  desc "generate_gallery", "create page for viewing images"
+  def generate_gallery(config_name)
+    dir = Wraith::Wraith.new(config_name)
+    puts 'Generating gallery'
+    `ruby lib/wraith/gallery.rb "#{dir.directory}"`
+  end
+
+  desc "capture config_name", "A full Wraith job"
+  def capture(config)
+  	reset_shots(config)
+  	setup_folders(config)
+  	check_for_paths(config)
+  	save_images(config)
+  	check_images(config)
+  	crop_images(config)
+  	compare_images(config)
+  	generate_thumbnails(config)
+  	generate_gallery(config)
+  end
+end

data/lib/wraith/compare_images.rb

@@ -0,0 +1,21 @@
+require 'wraith'
+
+class Wraith::CompareImages
+  attr_reader :wraith
+
+  def initialize(config)
+    @wraith = Wraith::Wraith.new(config)
+  end
+
+  def compare_images
+    files = Dir.glob("#{wraith.directory}/*/*.png").sort
+    until files.empty?
+      base, compare = files.slice!(0, 2)
+      diff = base.gsub(/([a-z0-9]+).png$/, 'diff.png')
+      info = base.gsub(/([a-z0-9]+).png$/, 'data.txt')
+      wraith.compare_images(base, compare, diff, info)
+      Dir.glob("#{wraith.directory}/*/*.txt").map { |f| "\n#{f}\n#{File.read(f)}" }
+      puts 'Saved diff'
+    end
+  end
+end

data/lib/wraith/crop.rb

@@ -0,0 +1,50 @@
+require 'wraith'
+require 'image_size'
+
+class Wraith::CropImages
+  attr_reader :wraith
+
+  def initialize(config)
+    @wraith = Wraith::Wraith.new(config)
+  end
+
+  def crop
+    crop_value(base_height, compare_height, @compare, @base)
+  end
+
+  def height
+    crop_value(base_height, compare_height, base_height, compare_height)
+  end
+
+  def base_height
+    find_heights(@base)
+  end
+
+  def compare_height
+    find_heights(@compare)
+  end
+
+  def crop_images
+    files = Dir.glob("#{wraith.directory}/*/*.png").sort
+    until files.empty?
+      @base, @compare = files.slice!(0, 2)
+      puts 'cropping images'
+      Wraith::Wraith.crop_images(crop, height)
+    end
+  end
+
+  def crop_value(base_height, compare_height, arg3, arg4)
+    if base_height > compare_height
+      arg3
+    else
+      arg4
+    end
+  end
+
+  def find_heights(height)
+    File.open(height, 'rb') do |fh|
+      size = ImageSize.new(fh.read).size
+      height = size[1]
+    end
+  end
+end

data/lib/wraith/error.rb

@@ -0,0 +1,3 @@
+module Wraith::Error
+
+end

data/lib/wraith/folder.rb

@@ -0,0 +1,40 @@
+require 'wraith'
+
+class Wraith::FolderManager
+  attr_reader :wraith
+  attr_accessor :paths
+
+  def initialize(config)
+    @wraith = Wraith::Wraith.new(config)
+  end
+
+  def dir
+    wraith.directory
+  end
+
+  def paths
+    wraith.paths
+  end
+
+  def spider_paths
+    if !paths
+      paths = File.read('spider.txt')
+      eval(paths)
+    else
+      wraith.paths
+    end
+  end
+
+  def clear_shots_folder
+    FileUtils.rm_rf("./#{dir}")
+    FileUtils.mkdir("#{dir}")
+  end
+
+  def create_folders
+    spider_paths.each do |folder_label, path| 
+      FileUtils.mkdir_p("#{dir}/thumbnails/#{folder_label}")
+      FileUtils.mkdir("#{dir}/#{folder_label}")
+    end
+    puts "Creating Folders"
+  end
+end

data/lib/wraith/gallery.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+
+# Given all the screenshots in the shots/ directory, produces a nice looking
+# gallery
+
+require 'erb'
+require 'pp'
+require 'fileutils'
+
+MATCH_FILENAME = /(\S+)_(\S+)\.\S+/
+TEMPLATE_LOCATION = "lib/wraith/gallery_template/gallery_template.erb"
+TEMPLATE_BY_DOMAIN_LOCATION = "lib/wraith/gallery_template/gallery_template.erb"
+BOOTSTRAP_LOCATION = "lib/wraith/gallery_template/bootstrap.min.css"
+
+def parse_directories(dirname)
+    dirs = {}
+    categories = Dir.foreach(dirname).select do |category|
+        if ['.', '..', 'thumbnails'].include? category
+            # Ignore special dirs
+            false
+        elsif File.directory? "#{dirname}/#{category}" then
+            # Ignore stray files
+            true
+        else
+            false
+        end
+    end
+
+    categories.each do |category|
+        dirs[category] = {}
+        Dir.foreach("#{dirname}/#{category}") do |filename|
+            match = MATCH_FILENAME.match(filename)
+            if not match.nil? then
+                size = match[1].to_i
+                group = match[2]
+                filepath = category + "/" + filename
+                thumbnail = "thumbnails/#{category}/#{filename}"
+
+                if dirs[category][size].nil? then
+                    dirs[category][size] = {:variants => []}
+                end
+                size_dict = dirs[category][size]
+
+                case group
+                when 'diff'
+                    size_dict[:diff] = {
+                        :filename => filepath, :thumb => thumbnail
+                    }
+                when 'data'
+                    size_dict[:data] = File.read("#{dirname}/#{filepath}")
+                else
+                    size_dict[:variants] << {
+                        :name => group,
+                        :filename => filepath,
+                        :thumb => thumbnail
+                    }
+
+                end
+                size_dict[:variants].sort! {|a, b| a[:name] <=> b[:name] }
+            end
+        end
+    end
+
+    return dirs
+end
+
+def generate_html(domain, directories, template, destination)
+    template = File.read(template)
+    html = ERB.new(template).result
+    File.open(destination, 'w') do |outf|
+        outf.write(html)
+    end
+end
+
+if ARGV.length < 1 then
+    puts "USAGE: create_gallery.rb <directory>"
+    exit 1
+end
+
+location = ARGV[0]
+domain = location
+directories = parse_directories(location)
+dest = "#{location}/gallery.html"
+
+generate_html(domain, directories, TEMPLATE_BY_DOMAIN_LOCATION, dest)
+FileUtils.cp(BOOTSTRAP_LOCATION, "#{location}/bootstrap.min.css")