capybara-maleficent 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfbcc71d8ada1e5f7ddf2fb70bb49469f8e40a30
-  data.tar.gz: 6b78006bcf7d237663123e96f1d2746a2f07d655
+  metadata.gz: b4abcd6ff72afa32a781cb14dbc05438a1d345df
+  data.tar.gz: 116b62e770c02a77da50cf43374264907ef2bf10
 SHA512:
-  metadata.gz: 2de676fc848823e78636caa79de294b1a762dfe650f550e010f2faca6eb52856d300e52f36ce9000767cf51f83d71b7e94b5422888473b6eff43fa5f9db67054
-  data.tar.gz: a48b6c95260a9fbd1ddf777c997e2fa739a4a6c0d90d40cc163404f8b198426216174cda112332df1f4f47c17996eeef1ca8df8d934b724c8dc8360987a004ec
+  metadata.gz: b74d54dd452882d65b3e1b195baf08dac8867f2538a4f415f84bcf5a366937a582e3ab9b1a30c146b4904ad4d36a125d8b1ec71cf9093385b005132323696025
+  data.tar.gz: 7bc24fcd7030ea844a7d4351d059c6789f8d0e797e9a3945205bceefbd1ad833b4f71c1178d3253f67055b0425454eae1d672a26e392e5463c4322ac9ec1d94c

data/lib/capybara/maleficent.rb

@@ -7,13 +7,15 @@ module Capybara
     #
     # A method that wraps the given block in a retry sleep strategy. Of particular use for waiting on Capybara.
     #
-    # @param [#sleep] the_sleeper - What will be doing the sleeping; default is Kernel
-    # @param [Array<Integer>] sleep_durations - The size of the array represents the max number of sleep attempts, each element represents how long
-    # @param [Array<Exceptions] handled_exceptions - Which exceptions should the sleep injector handle
+    # @param the_sleeper [#sleep] What will be doing the sleeping; default is Kernel
+    # @param logger [#debug, #info]
+    # @param sleep_durations [Array<Integer>] The size of the array represents the max number of sleep attempts, each element represents how long
+    # @param handled_exceptions [Array<Exceptions] Which exceptions should the sleep injector handle
     # @yield The block of code for which we will allow sleeping
     # @return The value of the given block
     # @see ./spec/lib/capybara/maleficent_spec.rb for specifications of behavior
-    def self.with_sleep_injection(the_sleeper: Kernel, sleep_durations: configuration.sleep_durations, handled_exceptions: configuration.handled_exceptions)
+    def self.with_sleep_injection(the_sleeper: Kernel, logger: configuration.logger, sleep_durations: configuration.sleep_durations, handled_exceptions: configuration.handled_exceptions)
+      logger.debug "Starting Capybara::Maleficent.with_sleep_injection"
       sleep_durations = sleep_durations.clone
       last_try_sleep_duration = sleep_durations.pop
       return_value = nil
@@ -23,13 +25,21 @@ module Capybara
           return_value = yield.tap { success = true }
           break if success
         rescue *handled_exceptions
+          logger.info "Sleeping for #{sleep_duration} via Capybara::Maleficent.with_sleep_injection (for #{handled_exceptions.inspect})"
           the_sleeper.sleep(sleep_duration)
           next
         end
       end
-      return return_value if success
-      the_sleeper.sleep(last_try_sleep_duration)
-      yield
+      if success
+        logger.debug "Ending Capybara::Maleficent.with_sleep_injection"
+        return return_value
+      else
+        logger.info "Sleeping for #{last_try_sleep_duration}via Capybara::Maleficent.with_sleep_injection (for #{handled_exceptions.inspect}). This is the last try."
+        the_sleeper.sleep(last_try_sleep_duration)
+        yield.tap do
+          logger.debug "Ending Capybara::Maleficent.with_sleep_injection"
+        end
+      end
     end
 
     def self.default_sleeper

data/lib/capybara/maleficent/configuration.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/array/wrap'
+require 'capybara/maleficent/logger'
 
 module Capybara
   module Maleficent
@@ -7,10 +8,13 @@ module Capybara
       def initialize(**kargs)
         self.sleep_durations = kargs.fetch(:sleep_durations) { [3, 10] }
         self.handled_exceptions = kargs.fetch(:handled_exceptions) { [] }
+        self.logger = kargs.fetch(:logger) { Capybara::Maleficent::Logger.new }
       end
 
       attr_accessor :handled_exceptions
 
+      attr_accessor :logger
+
       # Used to determine the number of sleeps to attempt, and the duration of each of those sleeps.
       # @return An array of integers
       attr_reader :sleep_durations

data/lib/capybara/maleficent/logger.rb

@@ -0,0 +1,21 @@
+module Capybara
+  module Maleficent
+    class Logger
+      def info(*args)
+        $stdout.puts("INFO: #{args.inspect}")
+      end
+
+      def debug(*args)
+        $stdout.puts("DEBUG: #{args.inspect}")
+      end
+
+      def error(*args)
+        $stdout.puts("ERROR: #{args.inspect}")
+      end
+
+      def warn(*args)
+        $stdout.puts("WARN: #{args.inspect}")
+      end
+    end
+  end
+end

data/lib/capybara/maleficent/spindle.rb

@@ -5,36 +5,27 @@ unless defined?(Capybara::Maleficent::Spindle)
   module Capybara::Maleficent::Spindle
   end
 
-  require "capybara/rspec/matchers"
   require "capybara/node/matchers"
-
-  # Re-open these classes as `super` was not working
-  class Capybara::RSpecMatchers::Matcher
-    def wrap_matches?(actual)
-      Capybara::Maleficent.with_sleep_injection(handled_exceptions: [Capybara::ExpectationNotMet]) do
-        wrap(actual)
-      end
-    rescue Capybara::ExpectationNotMet => e
-      @failure_message = e.message
-      return false
-    end
-  end
-
   module Capybara::Node::Matchers
-    def has_selector?(*args, &optional_filter_block)
-      Capybara::Maleficent.with_sleep_injection(handled_exceptions: [Capybara::ExpectationNotMet]) do
-        assert_selector(*args, &optional_filter_block)
-      end
-    rescue Capybara::ExpectationNotMet
-      false
-    end
-
-    def has_no_selector?(*args, &optional_filter_block)
-      Capybara::Maleficent.with_sleep_injection(handled_exceptions: [Capybara::ExpectationNotMet]) do
-        assert_no_selector(*args, &optional_filter_block)
+    # I was encountering issues with module inclusion and super method. This is
+    # an alternative to super. I grab the method (in this case instance method
+    # because it's a module), redefine the method to wrap the original method.
+    #
+    # http://blog.jayfields.com/2008/04/alternatives-for-redefining-methods.html
+    [
+      :assert_selector,
+      :assert_no_selector,
+      :assert_matches_selector,
+      :assert_not_matches_selector,
+      :assert_text,
+      :assert_no_text
+    ].each do |method_name|
+      original_method = instance_method(method_name)
+      define_method method_name do |*args, &block|
+        Capybara::Maleficent.with_sleep_injection(handled_exceptions: [Capybara::ExpectationNotMet]) do
+          original_method.bind(self).call(*args, &block)
+        end
       end
-    rescue Capybara::ExpectationNotMet
-      false
     end
   end
 end

data/lib/capybara/maleficent/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Maleficent
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-maleficent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,6 +102,7 @@ files:
 - lib/capybara-maleficent.rb
 - lib/capybara/maleficent.rb
 - lib/capybara/maleficent/configuration.rb
+- lib/capybara/maleficent/logger.rb
 - lib/capybara/maleficent/spindle.rb
 - lib/capybara/maleficent/version.rb
 - lib/capybara_maleficent.rb