likadan 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 049ef4a07ae70c43e7279f77d800c423e381602a
-  data.tar.gz: cae096cdc5663d6db1b3e94e239f463759623b77
+  metadata.gz: e2e0f6a6e6e21240adecd24471d2a8633a657332
+  data.tar.gz: 17d021b98744e745dcd915e2c00f04d44c812925
 SHA512:
-  metadata.gz: 5dab2617bfcced27c302464093c433a11aca50f13a4370cd6f02b0b45b9a20e7cdc3c588b870e1dcf42ee1245a0b0f340c90d6e12381c7c0f241d80ac8150572
-  data.tar.gz: d6628e5dcb20ea4f437951e6fd023b64778d80eaa558b9e047a1ed57d3d0fb45ce4b536015df713af1dff648e6767d425dea6a61e696176fcd1812c62fd76418
+  metadata.gz: e877633500eedfee6579a70a5df97a6e87698b105d7c31df4a30363165a9909ce091874eabb0e4e5d9d826d1b46b43d613818fb996da11c9e9f353f7fffe66d7
+  data.tar.gz: 234e8b43b05bff6fdf4a7d5af3650989ab6bb2b2e6179720c16590105017a710e0b40a6b25c0e798ca726019ce72456db2c386342e9e0be922234e5a8b277625

data/bin/likadan

@@ -8,12 +8,10 @@ require 'fileutils'
 action = ARGV[0] || 'run'
 case action
 when 'run'
-  Thread.new do # trivial example work thread
-    begin
-      require 'likadan_runner'
-    ensure
-      exit
-    end
+  Thread.abort_on_exception = true
+  Thread.new do
+    require 'likadan_runner'
+    exit
   end
   require 'likadan_server'
 
@@ -28,8 +26,8 @@ when 'clean'
 
 when 'approve', 'reject'
   abort 'Missing example name' unless example_name = ARGV[1]
-  abort 'Missing viewport width' unless width = ARGV[2]
-  LikadanAction.new(example_name, width).send(action)
+  abort 'Missing viewport name' unless viewport_name = ARGV[2]
+  LikadanAction.new(example_name, viewport_name).send(action)
 
 when 'upload_diffs'
   # `upload_diffs` returns a URL to a static html file

data/lib/likadan-diffs.html.erb

@@ -9,7 +9,7 @@
 
     <% diff_images.each do |diff| %>
       <h3>
-        <%= diff[:name] %> @ <%= diff[:width] %>
+        <%= diff[:name] %> @ <%= diff[:viewport] %>
       </h3>
       <p><img src="<%= diff[:url] %>"></p>
     <% end %>

data/lib/likadan_action.rb

@@ -2,15 +2,15 @@ require 'likadan_utils'
 require 'fileutils'
 
 class LikadanAction
-  def initialize(example_name, width)
+  def initialize(example_name, viewport_name)
     @example_name = example_name
-    @width = width
+    @viewport_name = viewport_name
   end
 
   def approve
-    diff_path = LikadanUtils.path_to(@example_name, @width, 'diff.png')
-    baseline_path = LikadanUtils.path_to(@example_name, @width, 'baseline.png')
-    candidate_path = LikadanUtils.path_to(@example_name, @width, 'candidate.png')
+    diff_path = LikadanUtils.path_to(@example_name, @viewport_name, 'diff.png')
+    baseline_path = LikadanUtils.path_to(@example_name, @viewport_name, 'baseline.png')
+    candidate_path = LikadanUtils.path_to(@example_name, @viewport_name, 'candidate.png')
 
     FileUtils.rm(diff_path, force: true)
 
@@ -20,8 +20,8 @@ class LikadanAction
   end
 
   def reject
-    diff_path = LikadanUtils.path_to(@example_name, @width, 'diff.png')
-    candidate_path = LikadanUtils.path_to(@example_name, @width, 'candidate.png')
+    diff_path = LikadanUtils.path_to(@example_name, @viewport_name, 'diff.png')
+    candidate_path = LikadanUtils.path_to(@example_name, @viewport_name, 'candidate.png')
 
     FileUtils.rm(diff_path, force: true)
     FileUtils.rm(candidate_path, force: true)

data/lib/likadan_runner.rb

@@ -9,27 +9,36 @@ require 'chunky_png'
 require 'likadan_utils'
 require 'fileutils'
 
+def resolve_viewports(example)
+  configured_viewports = LikadanUtils.config['viewports']
+
+  (example['options']['viewports'] || [configured_viewports.first.first]).map do |viewport|
+    configured_viewports[viewport].merge('name' => viewport)
+  end
+end
+
 driver = Selenium::WebDriver.for LikadanUtils.config['driver'].to_sym
 begin
   driver.navigate.to LikadanUtils.construct_url('/')
 
   while current = driver.execute_script('return window.likadan.next()') do
-    current['viewportWidths'].each do |width|
+    resolve_viewports(current).each do |viewport|
       # Resize window to the right size before rendering
-      driver.manage.window.resize_to(width, width)
+      driver.manage.window.resize_to(viewport['width'], viewport['height'])
 
       # Render the example
       rendered = driver.execute_script('return window.likadan.renderCurrent()')
       if error = rendered['error']
         puts <<-EOS
-          Error while rendering "#{current['name']}" @#{width}px:
+          Error while rendering "#{current['name']}" @#{viewport['name']}:
             #{rendered['error']}
           Debug by pointing your browser to
           #{LikadanUtils.construct_url('/', name: current['name'])}
         EOS
         next
       end
-      output_file = LikadanUtils.path_to(current['name'], width, 'candidate.png')
+      output_file = LikadanUtils.path_to(
+        current['name'], viewport['name'], 'candidate.png')
 
       # Create the folder structure if it doesn't already exist
       unless File.directory?(dirname = File.dirname(output_file))
@@ -45,10 +54,10 @@ begin
                     rendered['height'])
       cropped.save(output_file)
 
-      print "Checking \"#{current['name']}\" at #{width}px... "
+      print "Checking \"#{current['name']}\" at [#{viewport['name']}]... "
 
       # Run the diff if needed
-      baseline_file = LikadanUtils.path_to(current['name'], width, 'baseline.png')
+      baseline_file = LikadanUtils.path_to(current['name'], viewport['name'], 'baseline.png')
 
       if File.exist? baseline_file
         comparison = Diffux::SnapshotComparer.new(
@@ -57,7 +66,7 @@ begin
         ).compare!
 
         if img = comparison[:diff_image]
-          diff_output = LikadanUtils.path_to(current['name'], width, 'diff.png')
+          diff_output = LikadanUtils.path_to(current['name'], viewport['name'], 'diff.png')
           img.save(diff_output)
           puts "#{comparison[:diff_in_percent].round(1)}% (#{diff_output})"
         else

data/lib/likadan_server.rb

@@ -29,12 +29,12 @@ class LikadanServer < Sinatra::Base
   end
 
   post '/reject' do
-    LikadanAction.new(params[:name], params[:width]).reject
+    LikadanAction.new(params[:name], params[:viewport]).reject
     redirect back
   end
 
   post '/approve' do
-    LikadanAction.new(params[:name], params[:width]).approve
+    LikadanAction.new(params[:name], params[:viewport]).approve
     redirect back
   end
 

data/lib/likadan_uploader.rb

@@ -18,7 +18,7 @@ class LikadanUploader
     bucket.save(location: :us)
 
     diff_images = current_snapshots[:diffs].map do |diff|
-      image = bucket.objects.build("#{diff[:name]}_#{diff[:width]}.png")
+      image = bucket.objects.build("#{diff[:name]}_#{diff[:viewport]}.png")
       image.content = open(diff[:file])
       image.content_type = 'image/png'
       image.save

data/lib/likadan_utils.rb

@@ -9,6 +9,12 @@ class LikadanUtils
       'stylesheets' => [],
       'port' => 4567,
       'driver' => :firefox,
+      'viewports' => {
+        'desktop' => {
+          'width' => 1024,
+          'height' => 768
+        }
+      }
     }.merge(YAML.load(ERB.new(File.read(
       ENV['LIKADAN_CONFIG_FILE'] || '.likadan.yaml')).result))
   end
@@ -17,11 +23,11 @@ class LikadanUtils
     name.gsub(/[^a-zA-Z0-9\-_]/, '_')
   end
 
-  def self.path_to(name, width, file_name)
+  def self.path_to(name, viewport_name, file_name)
     File.join(
       config['snapshots_folder'],
       normalize_name(name),
-      "@#{width}",
+      "@#{viewport_name}",
       file_name
     )
   end
@@ -39,11 +45,11 @@ class LikadanUtils
 
   def self.current_snapshots
     prepare_file = lambda do |file|
-      width_dir = File.expand_path('..', file)
-      name_dir = File.expand_path('..', width_dir)
+      viewport_dir = File.expand_path('..', file)
+      name_dir = File.expand_path('..', viewport_dir)
       {
         name: File.basename(name_dir),
-        width: File.basename(width_dir).sub('@', '').to_i,
+        viewport: File.basename(viewport_dir).sub('@', ''),
         file: file,
       }
     end

data/lib/public/likadan-runner.js

@@ -4,14 +4,11 @@ window.likadan = {
   currentExample: undefined,
   currentRenderedElement: undefined,
 
-  define: function(name, func, viewportWidths, options) {
+  define: function(name, func, options) {
     this.defined.push({
       name: name,
       func: func,
-      viewportWidths: viewportWidths || [1024],
-      options: options || {
-        snapshotEntireScreen: false
-      }
+      options: options || {}
     });
   },
 

data/lib/views/review.erb

@@ -16,16 +16,16 @@
     <h2>DIFFS</h2>
     <% @snapshots[:diffs].each do |diff| %>
       <h3>
-        <%= diff[:name] %> @ <%= diff[:width] %>
+        <%= diff[:name] %> @ <%= diff[:viewport] %>
       </h3>
       <p><img src="/resource?file=<%= ERB::Util.url_encode(diff[:file]) %>"></p>
       <form style="display: inline-block"
-            action="/approve?name=<%= diff[:name] %>&width=<%= diff[:width] %>"
+            action="/approve?name=<%= diff[:name] %>&viewport=<%= diff[:viewport] %>"
             method="POST">
         <button type="submit">Approve</button>
       </form>
       <form style="display: inline-block"
-            action="/reject?name=<%= diff[:name] %>&width=<%= diff[:width] %>"
+            action="/reject?name=<%= diff[:name] %>&viewport=<%= diff[:viewport] %>"
             method="POST">
         <button type="submit">Reject</button>
       </form>
@@ -36,7 +36,7 @@
     <h2>BASELINES</h2>
     <% @snapshots[:baselines].each do |baseline| %>
       <h3>
-        <%= baseline[:name] %> @ <%= baseline[:width] %>
+        <%= baseline[:name] %> @ <%= baseline[:viewport] %>
       </h3>
       <p><img src="/resource?file=<%= ERB::Util.url_encode(baseline[:file]) %>"></p>
     <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: likadan
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Henric Trotzig