watchdoge 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3e163dcbfe0adf1bdd0cad7294c47475d7007792820a79a80d150cc86d58227
-  data.tar.gz: 8c03e0dff98141f87e822ac561a47b3267754e258425424d968aa5aef05c2c87
+  metadata.gz: 6bbea0942ea0ec77d65de759549b4fe4424fad15ed93b90334c4ce55bb82a19b
+  data.tar.gz: bf7a691395dfb78b147d3fc0cd26c1f182268c484f240c4ad641e6b44058a07f
 SHA512:
-  metadata.gz: 1f6f3564b357805882226d960aa97b69ab4f11d3a1d8f82d5a176995f5b15d9e42fbfadf9c38c9fed09b43cf2c33dda79abe7c316b277e599c0ae4def9d853e6
-  data.tar.gz: 8a7af25b9f84fe6475471dd5bd98207f51d3253f2197b37749126712125e052ed1732081eb479d582d3bb07e9cd98fe35006924d8beab30c73dacc8fa42cff5b
+  metadata.gz: b57a2f32f4b698d0166e9ec65603cfe3dc28e5c0b4c121392d9259bf8a7d73273a8f0098274a26b81dbed7422d1fd5c6cadd466c0ed13c575804c13870f7c337
+  data.tar.gz: 389b07819187d124daf610d66bcc1aae3db33f00bad613b19921b69d6f93f867a95aeaec45ac9f83640868c3517856f8b5072f426779c5eaeaa792a8595c0ddf

data/lib/watchdoge/configuration.rb

@@ -1,12 +1,17 @@
-# All configurable variables
+# All Configurable and Hooks
+
+# usage:
+#   WatchDoge.configure {|config|  #custom configuration }
 
 # spec:
-#
+#   1. able to load configuration file while WatchDoge.initilize! called
+#   2. able to setting multiple callbacks on one hook
 
 require 'watir'
 
 module WatchDoge
   class Configuration
+    # hook is array of Proc instances
     class Hooks
       attr_accessor :before_regression
       attr_accessor :after_regression
@@ -24,6 +29,7 @@ module WatchDoge
     attr_accessor :base_dir
 
     attr_accessor :web_drivers_dir
+
     attr_accessor :engine
     attr_accessor :browser
     attr_accessor :cookie_pool
@@ -42,6 +48,7 @@ module WatchDoge
     attr_accessor :firefox_version
 
     def initialize
+      # base_dir is where WatchDoge stuff operating include installation or configuration
       @base_dir =
         if defined? Rails
           Rails.root.to_s
@@ -49,32 +56,41 @@ module WatchDoge
           Dir.pwd
         end
 
+      # webdrivers binaries installation directory
       @web_drivers_dir = @base_dir + "/.webdrivers"
+
+
+      # framwork that Worker used, default to selenium
       @engine = Watir::Browser
+
+      # default browser used by engine
       @browser = :firefox
 
+      # 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
       @notifications = {
-        # slack: {
+        # 'SlackWebhook': {
         #   incoming_url: SLACK_WEBHOOK
         # }
-        # matter_most: {
+
+        # 'MatterMost': {
         #   host: HOST,
         #   channel_id: CHANNEL_ID,
         #   auth_token: AUTH_TOKEN
         # }
-        # matter_most: {
-        #   host: 'HOST',
-        #   channel_id: 'CHANNEL_ID',
-        #   auth_token: 'AUTH_TOKEN'
-        # }
       }
 
+      # host for relative URL in regression test.
       @host = ''
 
+      # regression directory contains reference images and scenario scripts
       @regression_dir =
         if defined?(Rails)
           @base_dir + "/test/watchdoge"
@@ -83,9 +99,14 @@ module WatchDoge
         end
 
       @hooks = WatchDoge::Configuration::Hooks.new
+
+      # Proc for #sign_in_as(resource) in regression scenario
+      #   worker: WatchDoge instance that executing scnario
+      #   resource: passed whatever you want
       @sign_in_proc = -> (worker, resource) {}
       @sign_out_proc = -> (worker, resource) {}
 
+      # specific webdriver version, default to latest if nil
       @chrome_version = nil
       @firefox_version = nil
     end

data/lib/watchdoge/image_diff.rb

@@ -5,7 +5,7 @@
 
 # spec:
 #   1. input only accept ChunkyPNG::Image, output image is also ChunkyPNG::Image
-#   2. Testing RGBA pixel by pixel. blending mask color if diff detected
+#   2. able to testing RGBA pixel by pixel. then blending with mask color if diff detected
 
 # todo: should improve testing boundary for more accurate diff imagenot.
 

data/lib/watchdoge/regression.rb

@@ -5,8 +5,8 @@
 #   WatchDoge::Regression.run_all_scenarios(:regression)
 
 # spec:
-#   1. rake tasks `rake watchdoge:make_reference` and `rake watchdoge:regression` while in Rails
-#   2. generate scenario template by Rails generator
+#   1. should have rake tasks `rake watchdoge:make_reference` and `rake watchdoge:regression` while in Rails
+#   2. able to generate scenario template by Rails generator
 
 # todo: support run single scenario
 

data/lib/watchdoge/version.rb

@@ -1,4 +1,4 @@
 # Version of WatchDoge
 module WatchDoge
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/watchdoge/worker.rb

@@ -6,9 +6,9 @@
 #   screenshot = worker.fullpage_screenshot
 
 # spec:
-#   1. Worker instance having customized configuration Selenium as its engine
-#   2. Worker engine default to headless mode
-#   3. Worker passing all missing method to its engine
+#   1. should having customized configuration Selenium as its engine
+#   2. engine should default to headless mode
+#   3. able to passing all missing method to its engine
 
 # todo:
 #   1. improve or remove cookie related functions, is it necessary for frontend regression?

data/lib/watchdoge.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'watchdoge/webdriver_manager'
 require 'watchdoge/version'
 require 'watchdoge/configuration'

data/watchdoge.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'watchdoge'
-  s.version     = '0.1.4'
+  s.version     = '0.1.5'
   s.date        = '2019-07-22'
   s.summary     = "dogi"
-  s.description = "A collection of web test tools"
+  s.description = "WatchDoge is Ruby on Rails friendly 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.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Shen Lee
@@ -104,7 +104,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-description: A collection of web test tools
+description: WatchDoge is Ruby on Rails friendly frontend regression test tool
 email: no-reply@gmail.com
 executables: []
 extensions: []