autobrewster 0.0.1 → 0.0.2

data/BSD-LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2013, Made By Made Ltd
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the "Made By Made Ltd" nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL MADE BY MADE LTD BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/auto_brewster/cli.rb

@@ -0,0 +1,21 @@
+module AutoBrewster
+  class CLI
+    def initialize(args)
+      @args = args
+    end
+
+    def execute!
+      AutoBrewster.send(get_action)
+    end
+
+    def get_action
+      return :compare_screens if @args.length < 1
+
+      if !AutoBrewster.respond_to?(@args[0])
+        raise "Action \"#{@args[0]}\" not available on AutoBrewster"
+      else
+        return @args[0].to_sym
+      end
+    end
+  end
+end

data/lib/auto_brewster/middleware.rb

@@ -0,0 +1,22 @@
+module AutoBrewster
+  class Middleware
+    attr_accessor :error
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if env["PATH_INFO"] == "/__identify__"
+        [200, {}, [@app.object_id.to_s]]
+      else
+        begin
+          @app.call(env)
+        rescue StandardError => e
+          @error = e unless @error
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/auto_brewster/screenshot.rb

@@ -0,0 +1,103 @@
+module AutoBrewster
+  class Screenshot
+    attr_accessor :server,
+                  :path,
+                  :url_paths,
+                  :screen_widths,
+                  :failed_fast
+
+    def initialize(server, path, url_paths, screen_widths)
+      @server = server
+      @path = path
+      @url_paths = url_paths
+      @screen_widths = screen_widths
+    end
+
+    def capture(output_directory)
+      @url_paths.each do |label, path|
+        @screen_widths.each do |width|
+          output_path = get_output_path(output_directory, label, width)
+          if File.exist?(output_path)
+            puts "Screenshot already exists for #{label} at #{width}. Skipping..."
+          else
+            puts `phantomjs #{snap_js_path} "#{get_url(path)}" "#{width}" "#{output_path}"`
+          end
+        end
+      end
+    end
+
+    def compare_captured_screens(failfast = false)
+      create_diff_dir
+      failures = 0
+
+      @url_paths.each do |label, path|
+        @screen_widths.each do |width|
+          check_source_compare_screens_exist(label, width)
+
+          source_path = get_output_path(:source, label, width)
+          compare_path = get_output_path(:compare, label, width)
+          diff_path = get_output_path(:diff, label, width)
+
+          output = `compare -fuzz 20% -metric AE -highlight-color blue #{source_path} #{compare_path} #{diff_path} 2>&1`
+
+          failures += get_failure_count(output, label, width)
+
+          if failfast
+            @failed_fast = true
+            exit 1
+          end
+        end
+      end
+
+      exit 1 if failures > 0
+    end
+
+    def check_source_compare_screens_exist(label, width)
+      [get_output_path(:source, label, width), get_output_path(:compare, label, width)].each do |path|
+        raise "Screenshot at #{path} does not exist" unless File.exist?(path)
+      end
+    end
+
+    def clear_source_screens
+      clear_screenshot_directory(:source)
+    end
+
+    def clear_compare_screens
+      clear_screenshot_directory(:compare)
+    end
+
+    def clear_diff_screens
+      clear_screenshot_directory(:diff)
+    end
+
+    private
+    def get_output_path(directory, label, width)
+      "#{@path}/screens/#{directory}/#{label}-#{width}.jpg"
+    end
+
+    def get_url(path)
+      "#{@server.get_host_with_protocol_and_port}#{path}"
+    end
+
+    def create_diff_dir
+      FileUtils.mkdir_p("#{@path}/screens/diff")
+    end
+
+    def clear_screenshot_directory(directory)
+      FileUtils.rm_rf Dir.glob("#{@path}/screens/#{directory}/*.jpg")
+    end
+
+    def snap_js_path
+      File.expand_path('../../../snap.js',  __FILE__)
+    end
+
+    def get_failure_count(output, label, width)
+      if output.strip! != "0"
+        puts "#{label} at #{width} wide doesn't match source screen"
+        return 1
+      end
+
+      return 0
+    end
+  end
+end

data/lib/auto_brewster/server.rb

@@ -0,0 +1,70 @@
+require 'rack'
+require 'net/http'
+require File.expand_path('../middleware',  __FILE__)
+
+module AutoBrewster
+  class Server
+    attr_accessor :port,
+                  :server,
+                  :rackup_path,
+                  :hostname,
+                  :app
+
+    def initialize(server, port, rackup_path = 'config.ru', hostname = false)
+      ENV['RACK_ENV'] ||= 'test'
+
+      @port = port
+      @server = server
+      @rackup_path = rackup_path
+      @hostname = hostname
+      @app = build_rack_app
+
+      @middleware = AutoBrewster::Middleware.new(@app)
+    end
+
+    def start
+      @server_thread = Thread.new do
+        @server.call(@middleware, @port)
+      end
+
+      Timeout.timeout(10) { @server_thread.join(0.1) until responsive? }
+    end
+
+    def stop
+      return if @server_thread.nil?
+      @server_thread.kill
+      Timeout.timeout(10) { @server_thread.join(0.1) until !responsive? }
+    end
+
+    def get_host_with_protocol_and_port
+      if @hostname
+        return @hostname
+      else
+        return "http://127.0.0.1:#{@port}"
+      end
+    end
+
+    private
+    def responsive?
+      return false if @server_thread and @server_thread.join(0)
+
+      res = Net::HTTP.start('127.0.0.1', @port) { |http| http.get('/__identify__') }
+
+      if res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+        return res.body == @app.object_id.to_s
+      end
+    rescue SystemCallError
+      return false
+    end
+
+    def build_rack_app
+      rackup_path = @rackup_path
+
+      Rack::Builder.new do
+        map '/' do
+          run Rack::Builder.parse_file(rackup_path)[0]
+        end
+      end.to_app
+    end
+  end
+end

data/snap.js

@@ -0,0 +1,30 @@
+var system = require('system');
+var page = require('webpage').create();
+var fs = require('fs');
+
+if (system.args.length === 3) {
+  console.log('Usage: snap.js <some URL> <view port width> <target image name>');
+  phantom.exit();
+}
+
+var url = system.args[1];
+var image_name = system.args[3];
+var view_port_width = system.args[2];
+
+page.viewportSize = { width: view_port_width, height: 1500};
+page.settings = { loadImages: true, javascriptEnabled: true };
+
+page.settings.userAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleWebKit/537.17 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.17',
+
+page.open(url, function(status) {
+  if (status === 'success') {
+    window.setTimeout(function() {
+      console.log('Snapping ' + url + ' at width ' + view_port_width);
+      page.render(image_name);
+      phantom.exit();
+    }, 3000);
+  } else {
+    console.log('Error with page ' + url);
+    phantom.exit();
+  }
+});

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Chris Blackburn
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-08-24 00:00:00 +01:00
+date: 2013-08-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,12 +64,18 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/auto_brewster/cli.rb
+- lib/auto_brewster/middleware.rb
+- lib/auto_brewster/screenshot.rb
+- lib/auto_brewster/server.rb
 - lib/auto_brewster.rb
 - bin/autobrewster
+- snap.js
+- BSD-LICENSE.txt
 has_rdoc: true
 homepage: https://github.com/madebymade/autobrewster
-licenses: []
-
+licenses: 
+- BSD
 post_install_message: 
 rdoc_options: []