compaa 0.0.3 → 0.0.4

data/bin/compaa

@@ -10,6 +10,7 @@ else
   require 'watir-webdriver'
 end
 require 'cgi'
+require 'fileutils'
 
 class App
   include Methadone::Main
@@ -60,7 +61,26 @@ class App
   end
 
   def self.screenshot_approved?
-    STDIN.gets.chomp.downcase.start_with? 'y'
+    while input = get_input
+      break if yes_or_no?
+
+      puts "It's a simple yes/no question, idiot!"
+    end
+
+    input == 'y'
+  end
+
+  def self.yes_or_no? input
+    input[0] == 'y' || input[0] == 'n'
+  end
+
+  def self.get_input
+    input = STDIN.gets
+
+    input.encode!('UTF-16', 'UTF-8', :invalid => :replace, :replace => '')
+    input.encode!('UTF-8', 'UTF-16')
+
+    input.downcase.chomp
   end
 
   version Compaa::VERSION

data/lib/compaa/generated_image.rb

@@ -22,6 +22,12 @@ module Compaa
       path.gsub 'screenshots_generated_this_run', 'reference_screenshots'
     end
 
+    def delete_difference_image
+      difference_image_path = path.gsub 'screenshots_generated_this_run', 'differences_in_screenshots_this_run'
+      difference_image_path << '_difference.gif'
+      file_manager.rm difference_image_path
+    end
+
     private
 
     def copy_and_create_directory dest

data/lib/compaa/rack_app.rb

@@ -22,6 +22,16 @@ module Compaa
             body   = Haml::Engine.new(template).render Object.new, locals
 
             [ 200, { 'Content-Type' => 'text/html' }, [body] ]
+          elsif request.path == '/script.js'
+            js = File.read File.expand_path('script.js', File.dirname(__FILE__))
+
+            [ 200, { 'Content-Type' => 'application/javascript' }, [js] ]
+          elsif request.path == '/screenshots' and request.request_method == 'POST' and request.params.has_key? 'filepath'
+            generated_image = GeneratedImage.new File.join(root, request.params['filepath'])
+            generated_image.create_reference_image
+            generated_image.delete_difference_image
+
+            [ 200, { 'Content-Type' => 'text/plain' }, ['Success'] ]
           else
             [ 404, {}, ['Not found'] ]
           end

data/lib/compaa/script.js

@@ -0,0 +1,77 @@
+var Compaa = {
+  filepath: function() {
+    queryString = window.location.search.replace('?', '');
+    return queryString.split('=')[1];
+  },
+
+  differenceGifPath: function() {
+    return this.filepath();
+  },
+
+  oldImagePath: function() {
+    return this.filepath().replace('gif', 'png').replace('_difference.png', '').replace('differences_in_screenshots_this_run','reference_screenshots');
+  },
+
+  newImagePath: function() {
+    return this.filepath().replace('gif', 'png').replace('_difference.png', '').replace('differences_in_screenshots_this_run', 'screenshots_generated_this_run');
+  },
+
+  initClickHandlers: function() {
+    document.getElementById('differenceButton').onclick = function() { Compaa.show('difference') };
+    document.getElementById('animationButton').onclick  = function() { Compaa.show('animation') };
+    document.getElementById('oldImageButton').onclick   = function() { Compaa.show('oldImage') };
+    document.getElementById('newImageButton').onclick   = function() { Compaa.show('newImage') };
+  },
+
+  hideAllImages: function() {
+    for (var i=0; i < this.imageTypes.length, i++) {
+      document.getElementById(this.imageTypes[i]).style.display = 'none';
+    }
+  },
+
+  show: function(mode) {
+    this.hideAllImages();
+    document.getElementById(mode).style.display = 'block';
+  },
+
+  setFormFilePath: function() {
+    document.getElementById('filepath').value = this.newImagePath;
+  },
+
+  imageTypes: ['difference', 'animation', 'oldImage', 'newImage'],
+
+  init: function() {
+    this.setFormFilePath();
+
+    var oldImg = document.createElement('img');
+    oldImg.src = this.oldImagePath();
+    
+    var newImg = document.createElement('img');
+    newImg.src = this.newImagePath();
+
+    document.getElementById('difference').width = oldImg.width;
+    document.getElementById('difference').height = oldImg.height;
+
+    document.getElementById('offScreenCanvas').width = newImg.width;
+    document.getElementById('offScreenCanvas').height = newImg.height;
+    
+    var over = document.getElementById('offScreenCanvas').getContext('2d'); 
+    over.drawImage(oldImg, 0, 0);
+
+    var under = document.getElementById('difference').getContext('2d');
+    under.drawImage(newImg, 0, 0);
+
+    over.blendOnto(under,'difference');
+
+    document.getElementById('oldImage').src = this.oldImagePath();
+    document.getElementById('newImage').src = this.newImagePath();
+
+    this.initClickHandlers();
+  }
+}
+
+document.onreadystatechange = function() {
+  if (document.readyState == "complete" || document.readyState == "interactive") {
+    Compaa.init();
+  }
+}

data/lib/compaa/template.haml

@@ -13,68 +13,8 @@
     %button#animationButton Animation
     %button#oldImageButton Old Image
     %button#newImageButton New Image
-  :javascript
-    var compaa = {
-      differenceGifPath: '#{filepath}',
-      oldImagePath: '#{filepath.gsub('gif', 'png').gsub('_difference.png', '').gsub('differences_in_screenshots_this_run','reference_screenshots')}',
-      newImagePath: '#{filepath.gsub('gif', 'png').gsub('_difference.png', '').gsub('differences_in_screenshots_this_run','screenshots_generated_this_run')}',
+    %form{:class => 'artifacts', :method => 'POST', :action => '/screenshots'}
+      %input#filepath{:name => 'filepath', :type => 'hidden', :value => ''}
+      %input{:type => 'submit', :value => 'Accept'}
 
-      init: function() {
-        var oldImg=document.createElement('img');
-        oldImg.src = compaa.oldImagePath
-        
-        var newImg=document.createElement('img');
-        newImg.src = compaa.newImagePath
-
-        document.getElementById('difference').width = oldImg.width;
-        document.getElementById('difference').height = oldImg.height;
-
-        document.getElementById('offScreenCanvas').width = newImg.width;
-        document.getElementById('offScreenCanvas').height = newImg.height;
-        
-        var over = document.getElementById('offScreenCanvas').getContext('2d'); 
-        over.drawImage(oldImg, 0, 0);
-
-        var under = document.getElementById('difference').getContext('2d');
-        under.drawImage(newImg, 0, 0);
-
-        over.blendOnto(under,'difference');
-
-        document.getElementById('oldImage').src = compaa.oldImagePath;
-        document.getElementById('newImage').src = compaa.newImagePath;
-
-        compaa.show('difference');
-
-        document.getElementById('differenceButton').onclick = function(){compaa.show('difference')};
-        document.getElementById('animationButton').onclick = function(){compaa.show('animation')};
-        document.getElementById('oldImageButton').onclick = function(){compaa.show('oldImage')};
-        document.getElementById('newImageButton').onclick = function(){compaa.show('newImage')};
-      },
-      show: function(mode) {
-        document.getElementById('difference').style.display = 'none';
-        document.getElementById('animation').style.display = 'none';
-        document.getElementById('oldImage').style.display = 'none';
-        document.getElementById('newImage').style.display = 'none';
-        
-        switch(mode){
-          case 'difference':
-            document.getElementById('difference').style.display = 'block';
-            break;
-          case 'animation':
-            document.getElementById('animation').style.display = 'block';
-            break;
-          case 'oldImage':
-            document.getElementById('oldImage').style.display = 'block';
-            break;
-          case 'newImage':
-            document.getElementById('newImage').style.display = 'block';
-            break;
-        }
-      }
-    }
-
-    document.onreadystatechange = function() {
-      if (document.readyState == "complete" || document.readyState == "interactive") {
-        compaa.init();
-      }
-    }
+  %script{:src => '/script.js'}

data/lib/compaa/version.rb

@@ -1,3 +1,3 @@
 module Compaa
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/generated_image_spec.rb

@@ -65,4 +65,16 @@ describe Compaa::GeneratedImage do
 
     subject.reference_path.must_equal reference_path
   end
+
+  it "deletes its corresponding difference image" do
+    subject.file_manager = mock_file_manager
+    difference_path =
+      File.join %w[artifacts differences_in_screenshots_this_run dir file.png_difference.gif]
+
+    mock_file_manager.expect :rm, true, [difference_path]
+
+    subject.delete_difference_image
+
+    mock_file_manager.verify
+  end
 end

data/spec/rack_app_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'rack/test'
+require 'pry'
+
+module Compaa
+  describe RackApp do
+    include Rack::Test::Methods
+
+    before do
+      @tmp_dir = File.expand_path('tmp', File.dirname(__FILE__))
+      FileUtils.mkdir_p @tmp_dir
+    end
+
+    after do
+      FileUtils.rm_rf @tmp_dir
+    end
+
+    def app
+      RackApp.new.tap { |a| a.root_directory = @tmp_dir }.app
+    end
+
+    def touch_file path
+      FileUtils.mkdir_p File.dirname(File.join(@tmp_dir, path))
+      FileUtils.touch   File.join(@tmp_dir, path)
+    end
+
+    describe "GET '/'" do
+      it "requires the filepath param" do
+        get '/'
+        assert_equal 404, last_response.status
+
+        get '/', :filepath => 'some/path'
+        assert last_response.ok?
+      end
+    end
+
+    describe "GET '/script.js'" do
+      it "returns our javascript" do
+        get '/script.js'
+        assert last_response.ok?
+        assert_equal 'application/javascript', last_response.headers['Content-Type']
+      end
+    end
+
+    describe "GET '/artifacts'" do
+      it "serves static files" do
+        touch_file 'artifacts/file.png'
+
+        get '/artifacts/file.png'
+
+        assert last_response.ok?
+        assert_equal 'image/png', last_response.headers['Content-Type']
+      end
+    end
+
+    describe "POST '/screenshots'" do
+      it "expects a filepath query" do
+        post '/screenshots'
+        assert_equal 404, last_response.status
+      end
+
+      it "copies the supplied image path to its reference image" do
+        touch_file 'artifacts/screenshots_generated_this_run/file.png'
+        touch_file 'artifacts/differences_in_screenshots_this_run/file.png_difference.gif'
+
+        refute File.exists? "#{@tmp_dir}/artifacts/reference_screenshots/file.png"
+        post '/screenshots', :filepath => 'artifacts/screenshots_generated_this_run/file.png'
+        assert File.exists? "#{@tmp_dir}/artifacts/reference_screenshots/file.png"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compaa
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-08 00:00:00.000000000Z
+date: 2013-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &22122940 !ruby/object:Gem::Requirement
+  requirement: &15554740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22122940
+  version_requirements: *15554740
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &22122100 !ruby/object:Gem::Requirement
+  requirement: &15553920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22122100
+  version_requirements: *15553920
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &22121020 !ruby/object:Gem::Requirement
+  requirement: &15553300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22121020
+  version_requirements: *15553300
 - !ruby/object:Gem::Dependency
   name: wrong
-  requirement: &22106200 !ruby/object:Gem::Requirement
+  requirement: &15552520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22106200
+  version_requirements: *15552520
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &22105280 !ruby/object:Gem::Requirement
+  requirement: &15551680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22105280
+  version_requirements: *15551680
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &22104480 !ruby/object:Gem::Requirement
+  requirement: &15550780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22104480
+  version_requirements: *15550780
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &22103520 !ruby/object:Gem::Requirement
+  requirement: &15549840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22103520
+  version_requirements: *15549840
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &22102680 !ruby/object:Gem::Requirement
+  requirement: &15549360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22102680
+  version_requirements: *15549360
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &22101640 !ruby/object:Gem::Requirement
+  requirement: &15548540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22101640
+  version_requirements: *15548540
 - !ruby/object:Gem::Dependency
   name: methadone
-  requirement: &22100160 !ruby/object:Gem::Requirement
+  requirement: &15547720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 1.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *22100160
+  version_requirements: *15547720
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &22099620 !ruby/object:Gem::Requirement
+  requirement: &15546920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22099620
+  version_requirements: *15546920
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
-  requirement: &22098520 !ruby/object:Gem::Requirement
+  requirement: &15546400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22098520
+  version_requirements: *15546400
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &22097640 !ruby/object:Gem::Requirement
+  requirement: &15545840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,7 +153,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22097640
+  version_requirements: *15545840
 description: 
 email:
 - skyhelpcentre@gmail.com
@@ -184,12 +184,14 @@ files:
 - lib/compaa/generated_image.rb
 - lib/compaa/null_object.rb
 - lib/compaa/rack_app.rb
+- lib/compaa/script.js
 - lib/compaa/template.haml
 - lib/compaa/version.rb
 - lib/watir-webdriver-fake.rb
 - log/newrelic_agent.log
 - spec/difference_image_spec.rb
 - spec/generated_image_spec.rb
+- spec/rack_app_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bskyb-commerce-helpcentre/compaa
 licenses: []
@@ -224,4 +226,5 @@ test_files:
 - features/support/matchers.rb
 - spec/difference_image_spec.rb
 - spec/generated_image_spec.rb
+- spec/rack_app_spec.rb
 - spec/spec_helper.rb