capybara-lockstep 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8335399770451283be7443be41f3f1e5c2b0401f16a64a7722fb6b39ec2f3143
-  data.tar.gz: 601249c76c50789b44199e734a64fb039cd3b77c1db3e9f9068b1e7dea188216
+  metadata.gz: 86f6aba93856539de9e2df301e720cced0c444de2d62436e72ea620765f9b3e1
+  data.tar.gz: 1ae5dc301b4761d7c51796313ea4a6210596b5975e02f639410916ddc53060b5
 SHA512:
-  metadata.gz: 638b0671d9f919c85b972cb2af4df763932a8c00ab21cd8387e3b483fda43448bb3c28b434aa821c0c6e75d4c67d82acb1dad0788128a5b1761bae0ae45400d6
-  data.tar.gz: eed68edd632b78dea169e208162e4a041cfc1ed2a78c6593eebf55d27d2fe54d9161e1c65f21771cb66de2ef4e2e2ce92573569118e30e8a3148368ffaaafe53
+  metadata.gz: b1dc1f1e4a8af3d4d02f4d7b2aec3ae99844ba42bd3713028a138842bdc296c6bc0ed39688b8c15d7976830cc97df9ebc96cee3f3cfc9ab5f799e99ec59fee23
+  data.tar.gz: 50e27f5304cc7fbc1ed0c74ee87311ef8c8a333ecd4395af7cf155305ce0607f4b0f20defdf901d8f5cb3cbe8fc1ddb23638d9587c27f15e2071aea59c24297c

data/.github/workflows/test.yml

@@ -7,9 +7,13 @@ on:
   pull_request:
     branches:
     - master
+  workflow_dispatch:
+    branches:
+    - master  
 jobs:
   test:
     runs-on: ubuntu-20.04
+    timeout-minutes: 3
     strategy:
       fail-fast: false
       matrix:
@@ -33,4 +37,8 @@ jobs:
         gem install bundler:2.2.15
         bundle install --no-deployment
     - name: Run tests
-      run: bundle exec rake spec
+      uses: nick-invision/retry@v2
+      with:
+        timeout_seconds: 30
+        max_attempts: 3
+        command: bundle exec rake spec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capybara-lockstep (0.7.0)
+    capybara-lockstep (1.0.0)
       activesupport (>= 3.2)
       capybara (>= 2.0)
       ruby2_keywords
@@ -44,10 +44,8 @@ GEM
       rake
     jasmine-core (3.6.0)
     mini_mime (1.1.0)
-    mini_portile2 (2.5.1)
     minitest (5.14.4)
-    nokogiri (1.11.3)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.11.3-x86_64-linux)
       racc (~> 1.4)
     phantomjs (2.1.1.0)
     public_suffix (4.0.6)

data/README.md

@@ -249,22 +249,6 @@ To enable logging in the browser console (but not STDOUT), include the snippet w
 capybara_lockstep(debug: true)
 ```
 
-
-## Disabling synchronization
-
-Sometimes you want to disable browser synchronization, e.g. to observe a loading spinner during a long-running request.
-
-To disable synchronization:
-
-```ruby
-begin
-  Capybara::Lockstep.enabled = false
-  do_unsynchronized_work
-ensure
-  Capybara::Lockstep.enabled = true
-end
-```
-
 ## Synchronization timeout
 
 By default capybara-lockstep will wait `Capybara.default_max_wait_time` seconds for the page initialize and for JavaScript and AJAX request to finish.
@@ -300,6 +284,32 @@ You may also synchronize from your client-side JavaScript. The following will ru
 CapybaraLockstep.synchronize(callback)
 ```
 
+
+## Disabling synchronization
+
+Sometimes you want to disable browser synchronization, e.g. to observe a loading spinner during a long-running request.
+
+To disable automatic synchronization:
+
+```ruby
+begin
+  Capybara::Lockstep.mode = :manual
+  do_unsynchronized_work
+ensure
+  Capybara::Lockstep.mode = :auto
+end
+```
+
+Note that you may still force synchronization by calling `Capybara::Lockstep.synchronize` manually.
+
+To completely disable synchronization:
+
+```ruby
+Capybara::Lockstep.mode = :off
+Capybara::Lockstep.synchronize # will not synchronize
+```
+
+
 ## Signaling asynchronous work
 
 If for some reason you want capybara-lockstep to consider additional asynchronous work as "busy", you can do so:

data/lib/capybara-lockstep/capybara_ext.rb

@@ -55,8 +55,7 @@ module Capybara
               # we force a non-lazy synchronization so we pick up all client-side changes
               # that have not been caused by Capybara commands.
               script_may_navigate_away = script =~ /\b(location|history)\b/
-              Lockstep.log "Synchronizing before script: #{script}"
-              Lockstep.synchronize(lazy: !script_may_navigate_away)
+              Lockstep.auto_synchronize(lazy: !script_may_navigate_away, log: "Synchronizing before script: #{script}")
             end
 
             super(script, *args, &block).tap do
@@ -143,9 +142,10 @@ module Capybara
   module Lockstep
     module SynchronizeWithCatchUp
       ruby2_keywords def synchronize(*args, &block)
-        # This method is called very frequently by capybara.
+        # This method is called by Capybara before most interactions with
+        # the browser. It is a different method than Capybara::Lockstep.synchronize!
         # We use the { lazy } option to only synchronize when we're out of sync.
-        Capybara::Lockstep.synchronize(lazy: true)
+        Capybara::Lockstep.auto_synchronize(lazy: true)
 
         super(*args, &block)
       end

data/lib/capybara-lockstep/configuration.rb

@@ -29,16 +29,30 @@ module Capybara
         @debug
       end
 
-      def enabled?
+      def mode
         if javascript_driver?
-          @enabled.nil? ? true : @enabled
+          @mode.nil? ? :auto : @mode
         else
-          false
+          :off
         end
       end
 
+      def mode=(mode)
+        @mode = mode
+      end
+
       def enabled=(enabled)
-        @enabled = enabled
+        case enabled
+        when true
+          log "Setting `Capybara::Lockstep.enabled = true` is deprecated. Set `Capybara::Lockstep.mode = :auto` instead."
+          self.mode = :auto
+        when false
+          log "Setting `Capybara::Lockstep.enabled = false` is deprecated. Set `Capybara::Lockstep.mode = :manual` or `Capybara::Lockstep.mode = :off` instead."
+          self.mode = :manual
+        when nil
+          # Reset to default
+          self.mode = nil
+        end
       end
 
       def wait_tasks
@@ -55,10 +69,6 @@ module Capybara
         @wait_tasks
       end
 
-      def disabled?
-        !enabled?
-      end
-
       private
 
       def javascript_driver?

data/lib/capybara-lockstep/lockstep.rb

@@ -23,14 +23,26 @@ module Capybara
         page.instance_variable_set(:@lockstep_synchronized, value)
       end
 
-      def synchronize(lazy: false)
-        if (lazy && synchronized?) || synchronizing? || disabled?
+      def synchronize(lazy: false, log: nil)
+        if (lazy && synchronized?) || synchronizing? || mode == :off
           return
         end
 
+        # Allow passing a log message that is only logged
+        # when we're actually synchronizing.
+        if log
+          self.log(log)
+        end
+
         synchronize_now
       end
 
+      def auto_synchronize(**options)
+        if mode == :auto
+          synchronize(**options)
+        end
+      end
+
       private
 
       def synchronize_now

data/lib/capybara-lockstep/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Lockstep
-    VERSION = "0.7.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-lockstep
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: Synchronize Capybara commands with client-side JavaScript and AJAX requests