lineup 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f3e24b0859c6f0c12ecf146e1564082f7f8a6a3
-  data.tar.gz: 08743eb9f69f2bd4b820c02a3799bd22e358acb5
+  metadata.gz: 07ab8f60bcebca9b0488e5c73d3ccbade289a521
+  data.tar.gz: 3dc3452596572439cc9e7f1342c496c93c7f487b
 SHA512:
-  metadata.gz: 259f123498f086d61fb790aec5b791d0a99b273f3eb7ee34aa3989b9a654c7cfe6b01f6bff25495f4227bff1c4104183fc92b468695474d1ecb51f15b540bf4b
-  data.tar.gz: 93f0f59e0ea444937fd85d0d9338be16bbfdb712186a4f69a1c8b2248a5b0a8c157c47c923be86931490b31bcc1b67814188ff44c4467d669f8f2c0cf5f37154
+  metadata.gz: 8ffe89fd8929d9c4bb7ad910acbb1d3bb90bcd08ba8480f8a679b187de182bcd228434067c22521d877752e52e8aacc5fede9ce23e3f3379e92f52b1533bd416
+  data.tar.gz: 9fa37586804eff1aa5d75a097333f6df8464ca811eff5ba7c0cb340da6c58f590e5295f89b4e993f6368f7a7e81cd6ce17f20aa646698293c8cf7bfed5591d96

data/bin/lineup

@@ -4,11 +4,7 @@ require '../lib/lineup'
 
 puts("This is an example. And a benchmark.")
 
-lineup = Lineup::Screenshot.new('https://prelive.otto.de')
-lineup.urls("/,multimedia,moebel,damenmode,mittesten")
-lineup.cookies([{"name"=>"trackingDisabled","value"=>"true","secure"=>false,"path"=>"/","domain"=>".otto.de"},
-                {"name"=>"survey","value"=>"1","secure"=>false,"path"=>"/","domain"=>".otto.de"}])
-lineup.localStorage(["us_customerServiceWidget"=>"{'customerServiceWidgetNotificationHidden':{'value':true,'timestamp':1467723066080}}"])
+lineup = Lineup::Screenshot.new('https://google.de')
 lineup.resolutions("600,800,1200")
 lineup.use_phantomjs false
 lineup.wait_for_asynchron_pages(2)

data/lib/controller/browser.rb

@@ -77,9 +77,9 @@ class Browser
       end
 
       if @localStorage.any?
-        @localStorage.each do |keyValue|
+        @localStorage.each do |key, value|
           # Generate javascript for localStorage.setItem, escaping single quotes in key and value
-          stmt = "localStorage.setItem('" + keyValue.keys.first.gsub("'", "\\\\'") + "','" + keyValue.values.first.gsub("'", "\\\\'") + "')";
+          stmt = "localStorage.setItem('" + key.gsub("'", "\\\\'") + "','" + value.gsub("'", "\\\\'") + "')";
           @browser.execute_script(stmt)
         end
       end

data/lib/lineup.rb

@@ -170,40 +170,11 @@ module Lineup
       @difference_path = path
     end
 
-
-    def cookie_for_experiment(cookie)
-
-      # a hash for a cookie can be set here. this is optional.
-      #
-      # e.g {name: 'experiment', value: 'experiment_value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
-      #
-      # if it is not nil it has to be an array:
-      if cookie
-        # generate :symbol => "value" hash map from "symbol" => "value"
-        cookie = cookie.inject({}) { |element, (symbol, value)| element[symbol.to_sym] = value; element }
-
-        #Validation
-        (raise "Cookie must be a hash of format
-              {name: 'experiment', value: 'experiment_value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
-              " unless cookie.is_a? Hash)
-
-        raise "cookie must have value for :name" unless (cookie[:name]).is_a? String
-        raise "cookie must have value for :value" unless (cookie[:value]).is_a? String
-        raise "cookie must have value for :domain" unless (cookie[:domain]).is_a? String
-        raise "cookie must have value for :path" unless (cookie[:path]).is_a? String
-        raise "cookie must have value for :secure" if (cookie[:secure]) == nil
-      end
-
-      # assign the variable
-
-      @cookie_for_experiment = cookie
-    end
-
     def cookies(cookies)
 
       # a hash for cookies can be set here. this is optional.
       #
-      # e.g {name: 'experiment', value: 'experiment_value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
+      # e.g {name: 'name', value: 'value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
       #
       # if it is not nil it has to be an array:
 
@@ -215,7 +186,7 @@ module Lineup
 
           #Validation
           (raise "Cookie must be a hash of format
-                {name: 'experiment', value: 'experiment_value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
+                {name: 'name', value: 'value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
                 " unless cookie.is_a? Hash)
 
           raise "cookie must have value for :name" unless (cookie[:name]).is_a? String
@@ -238,23 +209,19 @@ module Lineup
       #
       # if it is not nil it has to be an array:
 
-      @localStorage = []
+      @localStorage = {}
       if localStorage
-        localStorage.each do |keyValue|
-          # generate :symbol => "value" hash map from "symbol" => "value"
-          #keyValue = keyValue.inject({}) { |element, (symbol, value)| element[symbol.to_sym] = value; element }
-
-          #Validation
-          (raise "LocalStorage Key Value pair must be a hash of format
+        #Validation
+        (raise "LocalStorage must be a hash of format
                 {'key'=>'value'}
-                " unless keyValue.is_a? Hash)
+                " unless localStorage.is_a? Hash)
 
-          raise "LocalStorage Key Value pair must have exactly one key" unless (keyValue.keys.length) == 1
-          raise "LocalStorage Key Value pair must have exactly one value" unless (keyValue.values.length) == 1
-          raise "LocalStorage Key Value pair must have a string as key" unless (keyValue.keys.first).is_a? String
-          raise "LocalStorage Key Value pair must have a string as value" unless (keyValue.values.first).is_a? String
+        localStorage.each do |key, value|
+          raise "LocalStorage must have a string as key" if (key).empty?
+          raise "LocalStorage key must be a string" unless (key).is_a? String
+          raise "LocalStorage value must be a string" unless (value).is_a? String
 
-          @localStorage.push(keyValue)
+          @localStorage[key] = value
         end
       end
 
@@ -293,23 +260,13 @@ module Lineup
       use_phantomjs(configuration["use_phantomjs"])
       difference_path(configuration["difference_path"])
       wait_for_asynchron_pages(configuration["wait_for_asynchron_pages"])
-      cookie_for_experiment(configuration["cookie_for_experiment"])
       cookies(configuration["cookies"])
       localStorage(configuration["localStorage"])
 
-      if @cookies
-        cookies_merged= @cookies.inject([]) { |a, element| a << element.dup }
-      else
-        cookies_merged = []
-      end
-      if @cookie_for_experiment
-        cookies_merged.push(@cookie_for_experiment)
-      end
-
       # 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, @wait_for_asynchron_pages, cookies_merged, @localStorage]
+      [@urls, @resolutions, @screenshots_path, @headless, @difference_path, @wait_for_asynchron_pages, @cookies, @localStorage]
     end
 
 
@@ -325,16 +282,7 @@ module Lineup
       # and saves the screenshot in the file
       #   @screenshot_path
 
-      if @cookies
-        cookies_merged= @cookies.inject([]) { |a, element| a << element.dup }
-      else
-        cookies_merged = []
-      end
-      if @cookie_for_experiment
-        cookies_merged.push(@cookie_for_experiment)
-      end
-
-      browser = Browser.new(@baseurl, @urls, @resolutions, @screenshots_path, @headless, @wait_for_asynchron_pages, cookies_merged, @localStorage)
+      browser = Browser.new(@baseurl, @urls, @resolutions, @screenshots_path, @headless, @wait_for_asynchron_pages, @cookies, @localStorage)
       # 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
       browser.record(version)
@@ -358,7 +306,7 @@ module Lineup
       @urls.each { |url|
         @resolutions.each { |resolution|
           #threads[i] = Thread.new {
-            @comparer.push(Comparer.new(base, new, @difference_path, @baseurl, [url], [resolution], @screenshots_path))
+          @comparer.push(Comparer.new(base, new, @difference_path, @baseurl, [url], [resolution], @screenshots_path))
           #}
           #i+=1;
         }

data/lib/lineup/version.rb

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

data/tests/rspec/lineup_spec.rb

@@ -30,7 +30,7 @@ describe '#screeshot_recorder' do
     # Then
     expect(
         lineup.load_json_config(file)
-    ).to eq([['page1'], [13], 'screenshots/path', true, 'screenshots/path/difference', 5, [], []])
+    ).to eq([['page1'], [13], 'screenshots/path', true, 'screenshots/path/difference', 5, [], {}])
 
     # cleanup:
     FileUtils.rm file if (File.exists? file)
@@ -46,13 +46,6 @@ describe '#screeshot_recorder' do
              "use_phantomjs":true,
              "difference_path":"screenshots/path/difference",
              "wait_for_asynchron_pages":5,
-             "cookie_for_experiment":{
-                                      "name":"cookie1",
-                                      "value":"11111",
-                                      "domain":".google.de",
-                                      "path":"/",
-                                      "secure":false
-                                      },
              "cookies" : [{
                                       "name":"cookie2",
                                       "value":"22222",
@@ -67,7 +60,7 @@ describe '#screeshot_recorder' do
                                       "path":"/",
                                       "secure":false
                           }],
-             "localStorage":[{"myKey1":"myValue1"},{"myKey2":"myValue2"}]
+             "localStorage":{"myKey1":"myValue1","myKey2":"myValue2"}
              }'
     save_json(json, file)
 
@@ -79,9 +72,8 @@ describe '#screeshot_recorder' do
         lineup.load_json_config(file)
     ).to eq([['page1', 'page2'], [13,42], 'screenshots/path', true, 'screenshots/path/difference', 5,
              [{:name=>"cookie2", :value=>"22222", :domain=>".google.de", :path=>"/", :secure=>false},
-              {:name=>"cookie3", :value=>"33333", :domain=>".google.de", :path=>"/", :secure=>false},
-              {:name=>"cookie1", :value=>"11111", :domain=>".google.de", :path=>"/", :secure=>false}],
-             [{"myKey1"=>"myValue1"}, {"myKey2"=>"myValue2"}]])
+              {:name=>"cookie3", :value=>"33333", :domain=>".google.de", :path=>"/", :secure=>false}],
+             {"myKey1"=>"myValue1", "myKey2"=>"myValue2"}])
 
     # cleanup:
     FileUtils.rm file if (File.exists? file)
@@ -195,12 +187,12 @@ describe '#screeshot_recorder' do
     lineup.resolutions('400')
     lineup.wait_for_asynchron_pages(5)
     lineup.use_phantomjs(true)
-    cookie =  {"name" => "CONSENT",
+    cookie = [{"name" => "CONSENT",
                "value" => "YES+DE.de+V7",
                "domain" => ".google.de",
                "path" => "/",
-               "secure" => false}
-    lineup.cookie_for_experiment(cookie)
+               "secure" => false}]
+    lineup.cookies(cookie)
 
     lineup.record_screenshot('base')
     lineup.record_screenshot('new')
@@ -225,13 +217,6 @@ describe '#screeshot_recorder' do
              "use_phantomjs":true,
              "difference_path":"screenshots/path/difference",
              "wait_for_asynchron_pages":5,
-             "cookie_for_experiment":{
-                                      "name":"CONSENT",
-                                      "value":"YES+DE.de+V7",
-                                      "domain":".google.de",
-                                      "path":"/",
-                                      "secure":false
-                                      },
              "cookies" : [{
                                       "name":"cookie2",
                                       "value":"22222",
@@ -277,7 +262,7 @@ describe '#screeshot_recorder' do
              "use_phantomjs":true,
              "difference_path":"screenshots/path/difference",
              "wait_for_asynchron_pages":5,
-             "localStorage":[{"{\'mySpecialKey\'}":"{\'customerServiceWidgetNotificationHidden\':{\'value\':true,\'timestamp\':1467723066092}}"}]
+             "localStorage": {"{\'mySpecialKey\'}":"{\'myvalue\':{\'value\':test,\'timestamp\':1467723066092}}"}
              }'
     save_json(json, file)
     lineup = Lineup::Screenshot.new(BASE_URL)
@@ -302,7 +287,7 @@ describe '#screeshot_recorder' do
              "use_phantomjs":true,
              "difference_path":"screenshots/path/difference",
              "wait_for_asynchron_pages":5,
-             "localStorage":[{"us_customerServiceWidget":"{\'customerServiceWidgetNotificationHidden\':{\'value\':true,\'timestamp\':1467723066092}}"},{"myKey2":"myValue2"}]
+             "localStorage":{"\'myKey\'":"{\'myValue\'}","myKey2":"myValue2"}
              }'
     save_json(json, file)
     lineup = Lineup::Screenshot.new(BASE_URL)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lineup
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Finn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-05 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec