watchdoge 0.1.24 → 0.1.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a16fc3b9ab93bf0330328330314535ad9a74bc18caec50daf8327872564d4db
-  data.tar.gz: 28fa4084a510d0413af4d1d579e3ece2bcc480c7ca68c783a380587ac1d3f991
+  metadata.gz: 7ae7ad3051ac5d1eb15cb6008096e707772f61b9ad52ccf34340b7df8d2ff425
+  data.tar.gz: 68600410dde3c1f93372a35a6e9ddb1d7f77ef2335c91ebac512f2c2e6c9ad7d
 SHA512:
-  metadata.gz: '0999541a4012b25df6c64531f510279cf9509ccfccbdb98457b146a05eb51f3d4f1bacc96f96bcf659563010d558b64285229a9740fa100bc3763cf7bfaf1df6'
-  data.tar.gz: 1a7dc9b351fac103e1ee413bad479b3a805738f27818bdb505b4779063c74be55db38aff88fdb3d8325904fc0ee3d8265054ba8108dee3d5dc814cbdf36b25aa
+  metadata.gz: 326f1e9de08b859327fabb5b18b77a54d96c5313fe02d5306459c1803cde84e414564a30f126748c1eb889c5107c8f542ed3ea27ae55be66c25b1f737011003e
+  data.tar.gz: 10eb20ed919a1c6aec404951f3c4ad815d93a43f1aecdd81423d852e33c4cd137d9d53500fa01c01ade62eb3660e37540d045ae971605deff49da4aebf87f44d

data/lib/watchdoge/configuration.rb

@@ -33,9 +33,10 @@ module WatchDoge
     attr_accessor :web_drivers_dir
 
     attr_accessor :engine
-    attr_accessor :browser
     attr_accessor :cookie_pool
-    attr_accessor :http_timeout
+
+    attr_reader   :default_worker_options
+    attr_accessor :worker_options
 
     attr_accessor :notifications
 
@@ -65,15 +66,27 @@ module WatchDoge
       # framwork that Worker used, default to selenium
       @engine = Watir::Browser
 
-      # default browser used by engine
-      @browser = :firefox
+      # options for worker
+      @default_worker_options = {
+        # default window-size of worker
+        width: 1280,
+        height: 768,
+
+        # using Firfox as default browser
+        browser: :firefox,
+
+        # default to headless
+        headless: true,
+
+        # connection timeout threshold(seconds)
+        timeout: 120
+      }
+
+      @worker_options = {}
 
       # where all cookie saved (as yaml)
       @cookie_pool = @base_dir + '/.doge_cookie'
 
-      # connection timeout threshold(seconds)
-      @http_timeout = 120
-
       # map of notification sources
       #   key: must be stringify of its class name
       #   value: hash struct, will passed to constructor while push message

data/lib/watchdoge/notification/mattermost.rb

@@ -6,7 +6,7 @@ require 'uri'
 
 module WatchDoge
   module Notification
-    class Mattermost
+    class Mattermost < WatchDoge::Notification::Base
       def initialize args
         super
 

data/lib/watchdoge/notification/slack_webhook.rb

@@ -1,6 +1,6 @@
 module WatchDoge
   module Notification
-    class SlackWebhook
+    class SlackWebhook < WatchDoge::Notification::Base
       def initialize opt
         super
 

data/lib/watchdoge/rails/railtie.rb

@@ -6,17 +6,15 @@ module WatchDoge
       namespace :watchdoge do
         desc "generating reference images"
         task :capture => :environment do
+          WatchDoge.initialize!
           WatchDoge::Regression::Manager.run_all_scenarios :capture
         end
         desc "scrap screenshots and compare with reference images"
         task :test => :environment do
+          WatchDoge.initialize!
           WatchDoge::Regression::Manager.run_all_scenarios :test
         end
       end
     end
-
-    initializer "watchdoge.initialize" do |app|
-      WatchDoge.initialize!
-    end
   end
 end

data/lib/watchdoge/regression/dsl.rb

@@ -13,7 +13,14 @@ module WatchDoge
       def use browser
         puts "[use] browser #{browser}"
         @worker.close
-        @worker = WatchDoge::Worker.new @scenario_name, browser: browser
+
+        worker_options =
+          WatchDoge.configuration.default_worker_options.merge WatchDoge.configuration.worker_options
+
+        worker_options = worker_options.dup
+        worker_options[:browser] = browser
+
+        @worker = WatchDoge::Worker.new @scenario_name, worker_options
       end
 
       def sign_in_as resoruce
@@ -42,20 +49,20 @@ module WatchDoge
         @setup_proc.call if @setup_proc
 
         args = {
-          before: nil
+          wait: nil
         }.merge(kwargs)
 
-        args[:before].call if args[:before]
-
         @worker.goto path
 
-        if kwargs[:wait]
+        if args[:wait]
           @view_port.merge!({
-            wait: kwargs[:wait]
+            wait: args[:wait]
           })
         end
 
         @worker.resize_by_viewport(@view_port) do
+          yield(@worker) if block_given?
+
           case @regression_flag
           when :capture
             puts "  -> make reference images on worker #{@worker}"

data/lib/watchdoge/regression.rb

@@ -23,17 +23,17 @@ module WatchDoge
           WatchDoge.hooks.before_regression.each { |t| instance_exec &t }
 
           Dir["#{WatchDoge::Regression::Utils.scenarios_dir}/*"].each do |scenario_path|
-            WatchDoge.hooks.before_scenario.each { |t| instance_exec &t }
-
             mgr = self.new scenario_path, regression_flag: regression_flag
 
+            WatchDoge.hooks.before_scenario.each { |t| mgr.instance_exec &t }
+
             if WatchDoge.hooks.around_scenario
               WatchDoge.hooks.around_scenario.call(Proc.new { mgr.eval_scenario })
             else
               mgr.eval_scenario
             end
 
-            WatchDoge.hooks.after_scenario.each { |t| instance_exec &t }
+            WatchDoge.hooks.after_scenario.each { |t| mgr.instance_exec &t }
           end
 
           WatchDoge.hooks.after_regression.each { |t| instance_exec &t }
@@ -49,14 +49,17 @@ module WatchDoge
         @setup_proc = nil
         @teardown_proc = nil
 
-        @worker = WatchDoge::Worker.new @scenario_name
+        worker_options =
+          WatchDoge.configuration.default_worker_options.merge WatchDoge.configuration.worker_options
+
+        @worker = WatchDoge::Worker.new @scenario_name, worker_options.dup
 
         @view_port = {}
       end
 
       def eval_scenario
         puts "scenario: #{@scenario_name} begin"
-        eval File.read(@scenario_path)
+        instance_eval File.read(@scenario_path), @scenario_path
         @worker.close
         puts "scenario: #{@scenario_name} end\n"
         puts ""

data/lib/watchdoge/version.rb

@@ -1,4 +1,4 @@
 # Version of WatchDoge
 module WatchDoge
-  VERSION = '0.1.22'
+  VERSION = '0.1.27'
 end

data/lib/watchdoge/worker.rb

@@ -20,27 +20,24 @@ module WatchDoge
     #   2. height: browser's height, default to 768
     #   3. http_client: instance of Selenium::WebDriver::Remote::Http
     #   4. all acceptable arguments of Watir::Browser class
-    def initialize uid, options={}
+    def initialize uid, options
       @http = Selenium::WebDriver::Remote::Http::Default.new
-      @browser = WatchDoge.configuration.browser
 
       # HTTP timeout default to 120 sec
-      @http.read_timeout = options.delete(:timeout) || WatchDoge.configuration.http_timeout
+      @http.read_timeout = options.delete(:timeout)
 
-      @uid = uid
+      @browser = options[:browser]
 
-      default_options = {
-        width: 1280,
-        height: 768,
-        headless: true,
+      @uid = uid
 
+      options = {
         # Selenium HTTP configuration
         http_client: @http
-      }.merge(options).merge(browser_profile)
+      }.merge(options).merge(default_browser_profile)
 
       # intall required version driver
       WatchDoge::WebdriverManager.new @browser
-      @core = WatchDoge.configuration.engine.new @browser, default_options
+      @core = WatchDoge.configuration.engine.new @browser, options
 
       # for generate uri hash
       @landed_page = nil
@@ -52,8 +49,8 @@ module WatchDoge
       @cookie_loaded = false
 
       # width/height
-      @width = default_options[:width]
-      @height = default_options[:height]
+      @width = options[:width]
+      @height = options[:height]
       @core.window.resize_to @width, @height
     end
 
@@ -105,7 +102,7 @@ module WatchDoge
 
     private
 
-    def browser_profile
+    def default_browser_profile
       case @browser
       when :chrome
         prefs = {}

data/watchdoge.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'watchdoge'
-  s.version     = '0.1.24'
+  s.version     = '0.1.28'
   s.date        = '2019-07-22'
   s.summary     = "dogi"
-  s.description = "WatchDoge is Ruby on Rails friendly frontend regression test tool"
+  s.description = "WatchDoge is RubyOnRails-friendly web frontend regression test tool"
   s.authors     = ["Shen Lee"]
   s.email       = 'no-reply@gmail.com'
   s.files       = ["lib/watchdoge.rb"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watchdoge
 version: !ruby/object:Gem::Version
-  version: 0.1.24
+  version: 0.1.28
 platform: ruby
 authors:
 - Shen Lee
@@ -48,63 +48,63 @@ dependencies:
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 6.16.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.16'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 6.16.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.16'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.16.0
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-description: WatchDoge is Ruby on Rails friendly frontend regression test tool
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: WatchDoge is RubyOnRails-friendly web frontend regression test tool
 email: no-reply@gmail.com
 executables: []
 extensions: []
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: dogi