lineup 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca168f6253bc6111e22696d8b4f72e5a468ca804
-  data.tar.gz: bc2ffad3a74d03b3dbff81e5f980d81fd1c76644
+  metadata.gz: 750f82676b714c5dfa3a2ed55e48e941f16dcd3b
+  data.tar.gz: d22624093175f3ce9fff65c76a7505310b4b23f6
 SHA512:
-  metadata.gz: a87243428920002cd40dc99f824d97dc98630dccd022cc579e3dea71718598b7242fab291abf0b85dac13a86596b9dd0b394c1644ce48d32bda1b73badcd4592
-  data.tar.gz: 10ea27a5f54e0cb04ed9da5881ba276978d599c29be3c38dfb7fb983fd11349365746ac7cf93e70aaa630a48979da66688f95c355a2e4359b82cc6cf4e92935f
+  metadata.gz: c18638ee77d83b11c2b9358eb8d6c35ae54822a2f4fceb0d5b1c52e2e0e7c49a250a354b9202611fd6a78fb63a8e17277b48465aadd213d3e2079a073f69167d
+  data.tar.gz: e5ea889f6f5163f462fb3231e4408865df4ae20b55f0f2f44b90e1d50e36c4aa0c9558849855b143fb11aa39290c5131ac5122c8dbb24e1e256195e42979f862

data/README.md

@@ -1,7 +1,7 @@
 # Lineup
 
 Lineup is doing automated testing of webpage designs, eg. in continious delivery.
-If you push new code to production, you can evaluate the design of you page compared to a defined base design and
+If you push new code to production, you can evaluate the design of your page compared to a defined base design and
 get an analysis about the difference of the designs:
 
 For all images that you want to compare, you will receive information about how many pixel are different
@@ -51,7 +51,7 @@ lineup.compare('new', 'base')
 You can save it for later use:
 ````ruby
 lineup.save_json('/home/name/lineup/results/')
- => '/home/name/lineup/results/json.log'
+ => '/home/name/lineup/results/log.json'
 ````
 
 ## More configuration:
@@ -61,7 +61,7 @@ There are multiple ways to specify what to lineup and compare.
 By specifying different urls via ````#urls````:
 ````ruby
 lineup = Lineup::Screenshot.new('https://www.otto.de')
-lineup.urls("/, /multimedia, /sport")
+lineup.urls('/, /multimedia, /sport')
 ````
 This will do analysis of otto.de root (frontpage), otto.de/multimedia and otto.de/sport.
 It requires a comma separated string. Default value is only root.
@@ -69,22 +69,30 @@ It requires a comma separated string. Default value is only root.
 By specifying different resolutions via ````#resolutions````:
 ````ruby    
 lineup = Lineup::Screenshot.new('https://www.otto.de')
-lineup.resolutions("600, 800, 1200")
+lineup.resolutions('600, 800, 1200')
 ````
 The values are the browser width in pixel. For each size an analysis is done.
 It require a comma separated string. Default values are 640px, 800px and 1180px.
 
+By specifying a wait time for asychron elements on a page via ````#wait_for_asynchron_pages````:
+````ruby
+lineup = Lineup::Screenshot.new('https://www.otto.de')
+lineup.wait_for_asynchron_pages(5)
+````
+The wait time is the time in seconds lineup will wait after the page load before it takes a screenshot.
+In this time third party tools, AJAX or js as well as fonts can be (lazy) loaded. The wait time has no upper limit.
+
 By specifying a filepath for the screenshots via ````#filepath_for_images````:
 ````ruby    
 lineup = Lineup::Screenshot.new('https://www.otto.de')
-lineup.filepath_for_images(/home/myname/lineup/screenshots)
+lineup.filepath_for_images('/home/myname/lineup/screenshots')
 ````
 Creates a file and saves the screenshots in the file. Default is ````"#{Dir.pwd}/screenshots"````
 
 By specifying a filepath for the difference image via ````#difference_path````:
 ````ruby    
 lineup = Lineup::Screenshot.new('https://www.otto.de')
-lineup.difference_path(/home/myname/lineup/result)
+lineup.difference_path('/home/myname/lineup/result')
 ````
 Creates a file and saves the difference image in the file. Default is ````"#{Dir.pwd}/screenshots"````
 
@@ -98,7 +106,7 @@ If ````false```` the screenshots are taken in Firefox. ````#load_json_config````
 Load all above configs from a json file via 
 ````ruby    
 lineup = Lineup::Screenshot.new('https://www.otto.de')
-lineup.load_json_config(/home/myname/lineup/config.json)
+lineup.load_json_config('/home/myname/lineup/config.json')
 ````
 While my file contains all relevant information
 ````json
@@ -106,10 +114,13 @@ While my file contains all relevant information
   "urls":"/multimedia, /sport",
   "resolutions":"600,800,1200",
   "filepath_for_images":"~/images/",
-  "use_headless":true,
-  "difference_path":"#/images/diff"
+  "use_phantomjs":true,
+  "difference_path":"#/images/diff",
+  "wait_for_asynchron_pages":5
 }
 ````
+However, if the configuration is done with a json object, it needs to contain all information, there
+is no optional parameter.
 
 ## Example:
 
@@ -121,13 +132,14 @@ resolutions = '600, 800, 1200'
 images_path = '/home/myname/lineup/screenshots'
 difference_path = '/home/myname/lineup/results'
 json_path = 'home/myname/lineup/results'
-phantom = true
+phantomjs = true
 
 lineup = Lineup::Screenshot.new('https://www.otto.de')
 lineup.urls(urls)
 lineup.resolutions(resolutions)
 lineup.filepath_for_images(images_path
 lineup.difference_path(difference_path)
+lineup.use_phantomjs(phantomjs)
     
 lineup.record_screenshot(base_name)
 # do sth. (eg. deploy new software)

data/lib/controller/browser.rb

@@ -7,13 +7,14 @@ require_relative '../helper'
 
 class Browser
 
-  def initialize(baseurl, urls, resolutions, path, headless)
+  def initialize(baseurl, urls, resolutions, path, headless, wait)
     @absolute_image_path = path
     FileUtils.mkdir_p @absolute_image_path
     @baseurl = baseurl
     @urls = urls
     @resolutions = resolutions
     @headless = headless
+    @wait = wait
   end
 
   def record(version)
@@ -52,6 +53,7 @@ class Browser
     @browser.cookies.clear
     url = Helper.url(@baseurl, url)
     @browser.goto url
+    sleep @wait if @wait
     @browser.screenshot.save( File.expand_path(filename))
   end
 

data/lib/lineup/version.rb

@@ -1,7 +1,7 @@
 module Lineup
   class Version
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
 
     class << self

data/lib/lineup.rb

@@ -174,6 +174,24 @@ module Lineup
 
 
 
+    def wait_for_asynchron_pages(wait)
+
+      # if required a wait time in seconds can be set. This may be needed, if after pageload some
+      # elements are still loaded (Third-Party-Tools, AJAX, JS, Fonts)
+      #
+      # this value is a number (integer) how many seconds lineup will wait before taking a screenshot
+      #
+      # if its not an integer an exception is raised
+
+      raise "wait time needs to be an integer (wait time in seconds)" unless wait.is_a? Integer
+
+      # assign the variable
+
+      @wait_for_asynchron_pages = wait
+    end
+
+
+
     def load_json_config(path)
 
       # loads all possible configs from a json file.
@@ -190,11 +208,12 @@ module Lineup
       filepath_for_images(configuration["filepath_for_images"])
       use_phantomjs(configuration["use_phantomjs"])
       difference_path(configuration["difference_path"])
+      wait_for_asynchron_pages(configuration["wait_for_asynchron_pages"])
 
       # the method calls set the variables for the parameters, we return an array with all of them.
       # for the example above it is:
       # [["/multimedia", "/sport"], [600, 800, 1200], "~/images/", true, "#/images/diff"]
-      [@urls, @resolutions, @screenshots_path, @headless, @difference_path]
+      [@urls, @resolutions, @screenshots_path, @headless, @difference_path, @wait_for_asynchron_pages]
     end
 
 
@@ -211,7 +230,7 @@ module Lineup
       # and saves the screenshot in the file
       #   @screenshot_path
 
-      browser = Browser.new(@baseurl, @urls, @resolutions, @screenshots_path, @headless)
+      browser = Browser.new(@baseurl, @urls, @resolutions, @screenshots_path, @headless, @wait_for_asynchron_pages)
 
       # the only argument missing is if this is the "base" or "new" screenshot, this can be
       # passed as an argument. The value does not need to be "base" or "new", but can be anything

data/tests/rspec/lineup_spec.rb

@@ -15,7 +15,7 @@ describe '#screeshot_recorder' do
     # Given
     file = "#{Dir.pwd}/test_configuration.json"
     FileUtils.rm file if (File.exists? file)
-    json = '{"urls":"page1, page2","resolutions":"13,42","filepath_for_images":"some/path","use_phantomjs":true,"difference_path":"some/difference/image/path"}'
+    json = '{"urls":"page1, page2","resolutions":"13,42","filepath_for_images":"some/path","use_phantomjs":true,"difference_path":"some/difference/image/path",  "wait_for_asynchron_pages":5}'
     save_json(json, file)
 
     # When
@@ -24,7 +24,7 @@ describe '#screeshot_recorder' do
     # Then
     expect(
         lineup.load_json_config(file)
-    ).to eq([['page1', 'page2'], [13,42], 'some/path', true, 'some/difference/image/path'])
+    ).to eq([['page1', 'page2'], [13,42], 'some/path', true, 'some/difference/image/path', 5])
 
     # cleanup:
     FileUtils.rm file if (File.exists? file)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lineup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Finn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies: []
 description: lineup takes to screenshots of your app and compares them to references
   in order to find design flaws in your new code.
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: lineup will help you in your automated design regression testing