happo 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73690fa08fbd1338fc72d65f287329375b2a57ef
-  data.tar.gz: 8ff2614642f52154b7dbf7faccb75f01d98acdd5
+  metadata.gz: 5bc8376eac8e1bfacd86ac884e2123f2e5c26241
+  data.tar.gz: 1f4bdd2c779cd2568dcec63659c73068a37386e2
 SHA512:
-  metadata.gz: aa3ca88236618c91bad015f6d44188bf8799a1b5952d1f1e2c10745d2fcf425911605d089785bd6f1527d0b242615200d85ea7e076c4942379ef2ba8f8d6489c
-  data.tar.gz: ad36897001417b3dfe313e2c6ebf3448b9a6c42064c23ccf14a571c16c290505ec4d8ae2387aa4c7642b99e27431eb11eb74f1c7098e1d85232cbed65c01a203
+  metadata.gz: 13fad1aaf10906ad8c6583927d272d01ef2ab23fb75f74220b252cf53f496b37fb86149684014739ed9ed0779ab764dafb02a6f3a41d2d5049dfdb5f7609a38e
+  data.tar.gz: 2212b4bc094addb155238555da89797d4e89d4b48eccf3399a92a84d77d4af69f5b3555a3799dbab8c29d64a0bbde90df2d912bdee3fa2f08119b7af2c09ec17

data/bin/happo

@@ -9,8 +9,6 @@ Commands:
   debug
   review
   clean
-  approve
-  reject
   upload_diffs
   --help
   --version
@@ -39,13 +37,6 @@ when 'clean'
     FileUtils.remove_entry_secure Happo::Utils.config['snapshots_folder']
   end
 
-when 'approve', 'reject'
-  example_description = ARGV[1]
-  abort 'Missing example description' unless example_description
-  viewport_name = ARGV[2]
-  abort 'Missing viewport name' unless viewport_name
-  Happo::Action.new(example_description, viewport_name).send(action)
-
 when 'upload_diffs'
   # `upload_diffs` returns a URL to a static html file
   puts Happo::Uploader.new.upload_diffs

data/lib/happo/public/happo-styles.css

@@ -2,7 +2,3 @@ body {
   background-color: #f0f0f0;
   font-family: helvetica, arial;
 }
-
-form {
-  display: inline-block;
-}

data/lib/happo/runner.rb

@@ -144,35 +144,49 @@ begin
         log.log '.', false
       end
 
-      # Run the diff if needed
-      baseline_path = Happo::Utils.path_to(
-        description, viewport['name'], 'baseline.png')
-
-      if File.exist? baseline_path
-        # A baseline image exists, so we want to compare the new snapshot
-        # against the baseline.
+      # This is potentially expensive code that is run in a tight loop for every
+      # snapshot that we will be taking. With that in mind, we want to do as
+      # little work here as possible to keep runs fast. Therefore, we have
+      # landed on the following algorithm:
+      #
+      # 1. Delete previous.png if it exists.
+      # 2. Compare the current snapshot in memory against current.png if it
+      #    exists.
+      # 3. If there is a diff, move current.png to previous.png and write out
+      #    diff.png to disk and the current snapshot to current.png.
+      # 4. If there is no diff, return, leaving the old current.png in place.
+      previous_image_path = Happo::Utils.path_to(
+        description, viewport['name'], 'previous.png')
+      current_image_path = Happo::Utils.path_to(
+        description, viewport['name'], 'current.png')
+      diff_image_path = Happo::Utils.path_to(
+        description, viewport['name'], 'diff.png')
+
+      # We no longer need the old previous.png and diff.png, so lets remove them
+      # to keep things clean.
+      File.delete previous_image_path if File.exist? previous_image_path
+      File.delete diff_image_path if File.exist? diff_image_path
+
+      if File.exist? current_image_path
         comparison = Happo::SnapshotComparer.new(
-          ChunkyPNG::Image.from_file(baseline_path),
+          ChunkyPNG::Image.from_file(current_image_path),
           screenshot
         ).compare!
         log.log '.', false
 
         if comparison[:diff_image]
           # There was a visual difference between the new snapshot and the
-          # baseline, so we want to write the diff image and the new snapshot
+          # previous, so we want to write the diff image and the new snapshot
           # image to disk. This will allow it to be reviewed by someone.
-          diff_path = Happo::Utils.path_to(
-            description, viewport['name'], 'diff.png')
-          comparison[:diff_image].save(diff_path, :fast_rgba)
+          comparison[:diff_image].save(diff_image_path, :fast_rgba)
           log.log '.', false
 
-          candidate_path = Happo::Utils.path_to(
-            description, viewport['name'], 'candidate.png')
-          screenshot.save(candidate_path, :fast_rgba)
+          File.rename(current_image_path, previous_image_path)
+          screenshot.save(current_image_path, :fast_rgba)
           log.log '.', false
 
           percent = comparison[:diff_in_percent].round(1)
-          log.log log.cyan(" #{percent}% (#{candidate_path})")
+          log.log log.cyan(" #{percent}% (#{current_image_path})")
           result_summary[:diff_examples] << {
             description: description,
             viewport: viewport['name']
@@ -187,16 +201,15 @@ begin
           }
         end
       else
-        # There was no baseline image yet, so we want to start by saving a new
-        # baseline image.
+        # There was no snapshot yet, so we want to start by saving a new one.
 
         # Create the folder structure if it doesn't already exist
-        unless File.directory?(dirname = File.dirname(baseline_path))
+        unless File.directory?(dirname = File.dirname(current_image_path))
           FileUtils.mkdir_p(dirname)
         end
-        screenshot.save(baseline_path, :fast_rgba)
+        screenshot.save(current_image_path, :fast_rgba)
         log.log '.', false
-        log.log " First snapshot created (#{baseline_path})"
+        log.log " First snapshot created (#{current_image_path})"
         result_summary[:new_examples] << {
           description: description,
           viewport: viewport['name']

data/lib/happo/server.rb

@@ -53,16 +53,6 @@ module Happo
       end
     end
 
-    post '/reject' do
-      Happo::Action.new(params[:description], params[:viewport]).reject
-      redirect back
-    end
-
-    post '/approve' do
-      Happo::Action.new(params[:description], params[:viewport]).approve
-      redirect back
-    end
-
     run!
   end
 end

data/lib/happo/uploader.rb

@@ -4,9 +4,10 @@ require 'securerandom'
 module Happo
   class Uploader
     def initialize
-      @s3_access_key_id = Happo::Utils.config['s3_access_key_id']
-      @s3_secret_access_key = Happo::Utils.config['s3_secret_access_key']
-      @s3_bucket_name = Happo::Utils.config['s3_bucket_name']
+      @s3_access_key_id = ENV['S3_ACCESS_KEY_ID']
+      @s3_secret_access_key = ENV['S3_SECRET_ACCESS_KEY']
+      @s3_bucket_name = ENV['S3_BUCKET_NAME']
+      @s3_bucket_path = ENV['S3_BUCKET_PATH']
     end
 
     def upload_diffs
@@ -17,7 +18,11 @@ module Happo
                    result_summary[:new_examples].empty?
 
       bucket = find_or_build_bucket
-      dir = SecureRandom.uuid
+      dir = if @s3_bucket_path.nil? || @s3_bucket_path.empty?
+              SecureRandom.uuid
+            else
+              File.join(@s3_bucket_path, SecureRandom.uuid)
+            end
 
       diff_images = result_summary[:diff_examples].map do |diff|
         image = bucket.objects.build(
@@ -36,7 +41,7 @@ module Happo
           "#{dir}/#{example[:description]}_#{example[:viewport]}.png")
         image.content = open(Happo::Utils.path_to(example[:description],
                                                      example[:viewport],
-                                                     'baseline.png'))
+                                                     'previous.png'))
         image.content_type = 'image/png'
         image.save
         example[:url] = image.url

data/lib/happo/utils.rb

@@ -70,11 +70,11 @@ module Happo
 
       snapshots_folder = Happo::Utils.config['snapshots_folder']
       diff_files = Dir.glob("#{snapshots_folder}/**/diff.png")
-      baselines = Dir.glob("#{snapshots_folder}/**/baseline.png")
+      previous_images = Dir.glob("#{snapshots_folder}/**/previous.png")
 
       {
         diffs: diff_files.map(&prepare_file),
-        baselines: baselines.map(&prepare_file)
+        previous_images: previous_images.map(&prepare_file)
       }
     end
   end

data/lib/happo/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module Happo
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/happo/views/review.erb

@@ -12,26 +12,16 @@
         <%= h diff[:description] %> @ <%= diff[:viewport] %>
       </h3>
       <p><img src="/resource?file=<%= ERB::Util.url_encode(diff[:file]) %>"></p>
-      <form style="display: inline-block"
-            action="/approve?description=<%= diff[:description] %>&viewport=<%= diff[:viewport] %>"
-            method="POST">
-        <button type="submit">Approve</button>
-      </form>
-      <form style="display: inline-block"
-            action="/reject?description=<%= diff[:description] %>&viewport=<%= diff[:viewport] %>"
-            method="POST">
-        <button type="submit">Reject</button>
-      </form>
     <% end %>
 
     <hr>
 
-    <h2>BASELINES</h2>
-    <% @snapshots[:baselines].each do |baseline| %>
+    <h2>PREVIOUS</h2>
+    <% @snapshots[:previous_images].each do |previous_image| %>
       <h3>
-        <%= h baseline[:description] %> @ <%= baseline[:viewport] %>
+        <%= h previous_image[:description] %> @ <%= previous_image[:viewport] %>
       </h3>
-      <p><img src="/resource?file=<%= ERB::Util.url_encode(baseline[:file]) %>"></p>
+      <p><img src="/resource?file=<%= ERB::Util.url_encode(previous_image[:file]) %>"></p>
     <% end %>
   </body>
 </html>

data/lib/happo.rb

@@ -1,5 +1,4 @@
 require 'happo/utils'
-require 'happo/action'
 require 'happo/uploader'
 require 'happo/version'
 require 'happo/logger'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: happo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Henric Trotzig
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -144,7 +144,6 @@ extra_rdoc_files: []
 files:
 - bin/happo
 - lib/happo.rb
-- lib/happo/action.rb
 - lib/happo/diffs.html.erb
 - lib/happo/logger.rb
 - lib/happo/public/happo-runner.js

data/lib/happo/action.rb

@@ -1,33 +0,0 @@
-require 'happo/utils'
-require 'fileutils'
-
-module Happo
-  class Action
-    def initialize(example_description, viewport_name)
-      @example_description = example_description
-      @viewport_name = viewport_name
-    end
-
-    def approve
-      diff_path = Happo::Utils.path_to(
-        @example_description, @viewport_name, 'diff.png')
-      baseline_path = Happo::Utils.path_to(
-        @example_description, @viewport_name, 'baseline.png')
-      candidate_path = Happo::Utils.path_to(
-        @example_description, @viewport_name, 'candidate.png')
-
-      FileUtils.rm(diff_path, force: true)
-      FileUtils.mv(candidate_path, baseline_path) if File.exist? candidate_path
-    end
-
-    def reject
-      diff_path = Happo::Utils.path_to(
-        @example_description, @viewport_name, 'diff.png')
-      candidate_path = Happo::Utils.path_to(
-        @example_description, @viewport_name, 'candidate.png')
-
-      FileUtils.rm(diff_path, force: true)
-      FileUtils.rm(candidate_path, force: true)
-    end
-  end
-end