capybara-angular 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 693dad6d8c4ff820c47a41b26d0c680179148256
-  data.tar.gz: 72e6b43dbe008965532ddc18b864476c37f50d60
+SHA256:
+  metadata.gz: bcb03c75ee5122b2ac0feb6410f7592a00a7058539fa4d1a1c0911108a2024bf
+  data.tar.gz: 62b1d29e8b1561694249b40efce0804d827814fdf6c468349536ea84135f7b0f
 SHA512:
-  metadata.gz: a2960689f9869d6a45f269a49d60e8b6d3c42e98740b5e64a14acc029b2bdebe2dea0b5c25e9f2cf311ca5391ea71d500ea14a3364dee66ba311f4c490d3b814
-  data.tar.gz: 325b2b29a1741e706cd361bc8235bff5d1cd8f8cf2dd3accbf2c8a43ad83e58fa0968400cec6fb4431862c9d6062b35bd5dbae1ede3f9b166fdec3704256991d
+  metadata.gz: 1a230af009fe1cc36312d9ac5877549cc5377ec7f2eccb03355ef34c00bc862b75353ff6a5c4d2b74dc30681309ef2806605c034fd53b7c8a57f9f85bb35cecc
+  data.tar.gz: d8bb3cbfcfea3594475f67d1a5dab917a0c452b349a5cf4af213c7006fbef20ee338254d86bb94d7d261275032b84756794d3be50cf947f31a96e4638c951f87

data/.github/workflows/test-suite.yml

@@ -0,0 +1,46 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: test-suite
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile: ["rails-7.0.x"]
+        ruby: [3.2]
+        include:
+          - gemfile: rails-7.0.x
+            ruby: '3.1'
+          - gemfile: rails-7.0.x
+            ruby: '3.0'
+          - gemfile: rails-7.0.x
+            ruby: '2.7'
+          - gemfile: rails-6.1.x
+            ruby: '3.1'
+          - gemfile: rails-6.1.x
+            ruby: '3.0'
+          - gemfile: rails-6.1.x
+            ruby: 2.7
+          - gemfile: rails-6.0.x
+            ruby: 2.7
+          - gemfile: rails-5.2.x
+            ruby: 2.7
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/Gemfile.${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rspec

data/.gitignore

@@ -5,6 +5,7 @@
 .yardoc
 .rvmrc
 Gemfile.lock
+gemfiles/*.lock
 InstalledFiles
 _yardoc
 coverage

data/README.md

@@ -18,6 +18,13 @@ Use it as you would use regular Capybara API, however this time, you won't face
 include Capybara::Angular::DSL
 ```
 
+If you need to run some code without caring about AngularJS, you can use `ignoring_angular` like this:
+```ruby
+ignoring_angular do
+  # Your AngularJS agnostic code goes here
+end
+```
+
 ## Limitations
 
 At the moment it works with AngularJS applications initialized with `ng-app`.

data/capybara-angular.gemspec

@@ -17,11 +17,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.7"
 
   spec.add_dependency 'capybara', '>= 2.5.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "> 1.17", "< 3"
+  spec.add_development_dependency "rails", "> 5.2", "< 7.1"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "poltergeist"
+  spec.add_development_dependency "puma", "< 6"
 end

data/gemfiles/Gemfile.rails-5.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 5.2.0'

data/gemfiles/Gemfile.rails-6.0.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 6.0.0'

data/gemfiles/Gemfile.rails-6.1.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 6.1.0'

data/gemfiles/Gemfile.rails-7.0.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 7.0.0'

data/gemfiles/Gemfile.rails-edge

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', github: 'rails/rails'

data/lib/capybara/angular/dsl.rb

@@ -4,8 +4,8 @@ module Capybara
       include Capybara::DSL
 
       Capybara::Session::DSL_METHODS.each do |method|
-        define_method(method) do |*args, &block|
-          page.send(method, *args, &block)
+        define_method(method) do |*args, **kwargs, &block|
+          page.send(method, *args, **kwargs, &block)
         end
       end
 

data/lib/capybara/angular/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Angular
-    VERSION = "0.2.5"
+    VERSION = "0.3.0"
   end
 end

data/lib/capybara/angular/waiter.js

@@ -0,0 +1,53 @@
+// This script is injected from waiter.rb.  It is responsible for setting
+// window.capybaraAngularReady when either a) angular is ready, or b)
+// it determines the page is not an angular page.
+
+(function () {
+  "use strict";
+
+  window.capybaraAngularReady = false;
+
+  function ready() {
+    window.capybaraAngularReady = true;
+  }
+
+  function angularPresent() {
+    return window.angular !== undefined;
+  }
+
+  function element() {
+    return document.querySelector("[ng-app], [data-ng-app]") || document.querySelector("body");
+  }
+
+  function elementPresent() {
+    return element() !== undefined;
+  }
+
+  function setupTestability() {
+    try {
+      angular.getTestability(element()).whenStable(ready);
+    } catch (err) {
+      ready();
+    }
+  }
+
+  function setupInjector() {
+    try {
+      angular.element(element()).injector().get("$browser").notifyWhenNoOutstandingRequests(ready);
+    } catch (err) {
+      ready();
+    }
+  }
+
+  function setup() {
+    if (!angularPresent() || !elementPresent()) {
+      ready();
+    } else if (angular.getTestability) {
+      setupTestability();
+    } else {
+      setupInjector();
+    }
+  }
+
+  setup();
+}());

data/lib/capybara/angular/waiter.rb

@@ -1,6 +1,8 @@
 module Capybara
   module Angular
     class Waiter
+      WAITER_JS = IO.read(File.expand_path "../waiter.js", __FILE__)
+
       attr_accessor :page
 
       def initialize(page)
@@ -8,23 +10,24 @@ module Capybara
       end
 
       def wait_until_ready
-        return unless angular_app?
-
-        setup_ready
-
+        return unless driver_supports_js?
         start = Time.now
+
         until ready?
+          inject_waiter
           timeout! if timeout?(start)
-          if page_reloaded_on_wait?
-            return unless angular_app?
-            setup_ready
-          end
           sleep(0.01)
         end
       end
 
       private
 
+      def driver_supports_js?
+        page.evaluate_script "true"
+      rescue Capybara::NotSupportedByDriverError
+        false
+      end
+
       def timeout?(start)
         Time.now - start > Capybara::Angular.default_max_wait_time
       end
@@ -33,37 +36,13 @@ module Capybara
         raise Timeout::Error.new("timeout while waiting for angular")
       end
 
-      def ready?
-        page.evaluate_script("window.angularReady")
-      end
-
-      def angular_app?
-        js = '!!window.angular'
-        page.evaluate_script js
-
-      rescue Capybara::NotSupportedByDriverError
-        false
-      end
-
-      def setup_ready
-        page.execute_script <<-JS
-          var el = document.querySelector('[ng-app], [data-ng-app]') || document.querySelector('body');
-
-          window.angularReady = false;
-
-          if (angular.getTestability) {
-            angular.getTestability(el).whenStable(function() { window.angularReady = true; });
-          } else {
-            var $browser = angular.element(el).injector().get('$browser');
-
-            if ($browser.outstandingRequestCount > 0) { window.angularReady = false; }
-            $browser.notifyWhenNoOutstandingRequests(function() { window.angularReady = true; });
-          }
-        JS
+      def inject_waiter
+        return if page.evaluate_script("window.capybaraAngularReady !== undefined")
+        page.execute_script WAITER_JS
       end
 
-      def page_reloaded_on_wait?
-        page.evaluate_script("window.angularReady === undefined")
+      def ready?
+        page.evaluate_script("window.capybaraAngularReady === true")
       end
     end
   end

data/spec/capybara/angular_spec.rb

@@ -1,4 +1,6 @@
 require 'rack'
+require 'puma'
+require 'rack/handler/puma'
 require 'capybara'
 require 'capybara/rspec'
 require 'capybara/poltergeist'
@@ -27,6 +29,16 @@ feature 'Waiting for angular' do
     timeout_page_should_have_waited
   end
 
+  scenario 'when visiting a non-angular page' do
+    open_non_angular_page
+    non_angular_page_should_load
+  end
+
+  scenario 'when visiting a non-angular page that loads angular javascript' do
+    open_non_angular_page_with_angular_javascript
+    non_angular_page_should_load
+  end
+
   def open_manual_bootstrap_page
     visit '/manual.html'
   end
@@ -39,7 +51,19 @@ feature 'Waiting for angular' do
     visit '/ng-app-not-on-body.html'
   end
 
+  def open_non_angular_page
+    visit '/non-angular-page.html'
+  end
+
+  def open_non_angular_page_with_angular_javascript
+    visit '/non-angular-page-with-angular-javascript.html'
+  end
+
   def timeout_page_should_have_waited
     expect(page).to have_content('waited')
   end
+
+  def non_angular_page_should_load
+    expect(page).to have_content('non-angular page')
+  end
 end

data/spec/public/non-angular-page-with-angular-javascript.html

@@ -0,0 +1,8 @@
+<html>
+<head>
+    <script src="/js/angular-1.5.8.js"></script>
+</head>
+<body>
+non-angular page
+</body>
+</html>

data/spec/public/non-angular-page.html

@@ -0,0 +1,6 @@
+<html>
+<head/>
+<body>
+non-angular page
+</body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-angular
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Pawel Pierzchala
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -28,16 +28,42 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +106,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 description: Capybara API that knows how to wait for Angular in end to end specs
 email:
 - pawelpierzchala@gmail.com
@@ -87,6 +127,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test-suite.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -94,9 +135,15 @@ files:
 - README.md
 - Rakefile
 - capybara-angular.gemspec
+- gemfiles/Gemfile.rails-5.2.x
+- gemfiles/Gemfile.rails-6.0.x
+- gemfiles/Gemfile.rails-6.1.x
+- gemfiles/Gemfile.rails-7.0.x
+- gemfiles/Gemfile.rails-edge
 - lib/capybara/angular.rb
 - lib/capybara/angular/dsl.rb
 - lib/capybara/angular/version.rb
+- lib/capybara/angular/waiter.js
 - lib/capybara/angular/waiter.rb
 - spec/capybara/angular_spec.rb
 - spec/public/js/angular-1.5.8.js
@@ -104,11 +151,13 @@ files:
 - spec/public/manual.html
 - spec/public/ng-app-not-on-body.html
 - spec/public/ng-app.html
+- spec/public/non-angular-page-with-angular-javascript.html
+- spec/public/non-angular-page.html
 homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,16 +165,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Stable Capybara API for AngularJS applications
 test_files:
@@ -135,3 +183,5 @@ test_files:
 - spec/public/manual.html
 - spec/public/ng-app-not-on-body.html
 - spec/public/ng-app.html
+- spec/public/non-angular-page-with-angular-javascript.html
+- spec/public/non-angular-page.html