loader_detector 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b9069f03bb3197d38a351062d1f35f90e2cba16b20a4e51ed25a288fb731973
+  data.tar.gz: 15b6a7a4bf4a8c26d57e17adf96c8cf3d4370f3d23e48b3c488d8f275819075a
+SHA512:
+  metadata.gz: 71c8b3d62b4c07d1695fc959998fb02e7ed5f2eabfe17498c03164ebd77724249afeafbe06d6b572b74e5c05a6f09d2526c05ede6abd2737424c148abde40b88
+  data.tar.gz: f427e85564680415793fabccb826cdda10c9b2e7d7e288072f5ccfabca41d0e816cfcf1b873407e36231cb648686a50c802e750bd8d7d59a2ed7b8300060dc6c

data/ext/loader_detector/extconf.rb

@@ -0,0 +1,4 @@
+require "mkmf"
+
+$LIBS = '-lnetpbm'
+create_makefile "loader_detector/loader_detector"

data/lib/loader_detector.rb

@@ -0,0 +1,117 @@
+require "loader_detector/loader_detector"
+require 'shotgun_ruby'
+
+
+module LoaderDetector
+    class Detector
+        class IDnotSetError < StandardError
+            def initialize(msg="the id of the window to be screenshotted isn't set. Call initialize(id) first.")
+            super(msg)
+            end
+        end
+        class ThresholdNegativeError < StandardError
+            def initialize(msg="The pixel difference threshold is negative. Please set a positive value or use the default value (0)")
+            super(msg)
+            end
+        end
+
+        @@logger = Logger.new(STDOUT)
+
+        attr_reader :id, :threshold
+
+        ##
+        # Sets the id of the window of which the program will take screenshots and creates the two initial screenshots.
+        #
+        # @param id [String] id of the window to be screenshotted
+        # @param threshold [Integer] threshold for the pixel difference between two screenshots. If the difference is below the threshold the website is assumed to be loaded.
+        # @param frame_count [Integer] number of times the pixel difference has to be below the threshold to assume that the website is loaded.
+        # @param timeout [Integer] number of seconds the program will wait for the website to load.
+        # @raise [IDnotSetError] if the id of the window to be screenshotted isn't set
+        # @raise [ThresholdNegativeError] if the pixel difference threshold is negative
+        def initialize( driver, threshold = 0, frame_count = 10, timeout = 10 )
+            raise IDnotSetError.new if id == ""
+            raise ThresholdNegativeError.new if threshold < 0
+
+            @driver = driver
+            @threshold = threshold
+            @frame_count = frame_count
+            @timeout = timeout
+        end
+
+        # Checks if a website has finished loading already. Calls the comparison algorithm, if the pixel difference is below the threshold 10 times in a row it assumes that the website doesn't change anymore. 
+        def wait_until_content_loaded
+            imagefile1 = Tempfile.new(['image1', '.pnm'])
+            imagefile2 = Tempfile.new(['image2', '.pnm'])
+
+            @driver.pam_screenshot_file(imagefile1.path)
+
+            count = 0
+            t0 = Time.now
+
+            while Time.now - t0 < @timeout do
+
+                @driver.pam_screenshot_file(imagefile2.path)
+
+                count = difference_detected?(imagefile1, imagefile2) ? 0 : count + 1
+
+                begin
+                    File.rename(imagefile2.path, imagefile1.path)
+                rescue Errno::ENOENT
+                    logger.warn("Can't rename imagefile2")
+                end
+
+                if count >= @frame_count
+                    yield if block_given?
+                    return true
+                end
+            end
+
+            logger.warn("check_loading timed out. Couldn't detect a loaded website.")
+
+            return false
+        end
+
+        private
+
+        #Compares two images. Takes screenshots and compares them using netpbm.
+        def difference_detected?(imagefile1, imagefile2)
+            pixeldiff = LoaderDetector.compare_pamfiles( imagefile1.path, imagefile2.path )
+        
+            case pixeldiff
+            when -1
+                logger.warn("Window size changed")
+                return true
+            when -2
+                logger.error("Can't open image file")
+                return true
+            when -3
+                logger.error("Some image dimension = 0")
+                return true
+            end
+
+            return pixeldiff > @threshold
+        end
+
+        ##
+        # @return [Logger] Logger instance
+        def logger
+            @@logger
+        end
+    end
+
+    class ScreenshotDriver
+        def pam_screenshot_file( file_path )
+          raise 'not implemented'
+        end
+    end
+
+    class ShotgunRubyDriver < ScreenshotDriver
+        def initialize( window_id )
+            @window_id = window_id.strip
+        end
+      
+        def pam_screenshot_file( file_path )
+            ShotgunRuby.screenshot( @window_id, file_path )
+        end
+    end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: loader_detector
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jonas Moesicke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shotgun_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: loader_detector was developed to efficiently detect changes on websites.
+  It does this by using fast screenshots and counting the pixel differences between
+  these screenshots. It can be used in automated test scenarios to determine whether,
+  for example, a loader is still running on the tested website or whether the loading
+  process has been completed.
+email: 
+executables: []
+extensions:
+- ext/loader_detector/extconf.rb
+extra_rdoc_files: []
+files:
+- ext/loader_detector/extconf.rb
+- lib/loader_detector.rb
+homepage: https://github.com/jm591/loader_detector
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Loader detection for automated website testing
+test_files: []