capybara-experience 0.1.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01845d3b647bd5c05da6b2cf5dea1cd5683efc0e64c36d8cc92099a7dd2ac266'
-  data.tar.gz: ea5f0e3925085dc98fdfe8bc92ca2a8880b6d630406b50d6bd724b102762f654
+  metadata.gz: 9e604603bfb1f0fde33216fc173bd1c4050a93251f8009054c68fc920996a6e6
+  data.tar.gz: 5672e3dd951dbbeb68513427e07c79607cadeb4b6812b7d8b431da06830d126f
 SHA512:
-  metadata.gz: 2e3a38fcfcfa9400c33e14ec4d8717bdc72192f819282e1ec998ee15ced37bd3177a24f5a555a2bea33eb451dc4656fda63ea5837f0bebb250ac642c146ca864
-  data.tar.gz: 472bdb5fedb119defde0e5c1337ce5cf6e30ee1e0cc5573244fbbeb4cde75dee9bcc586f42bf09b5b3e5b9fe9eca711762d20f0a29f492cd63fe943b54c8a24d
+  metadata.gz: 4e729f9c62eda4bb7d5d446d5215c199c3443419841a3c876a7378cdd8f2a6766e9c5589b2cc320c60d2577f0f9314bd9a3b43a3238562acf6a48283c66d4e97
+  data.tar.gz: 6d913cbe6e6bbde172f82175317d217ef0b1edd8a11a5fa2883e6cf41b13208dcf9cab603cb8c7a51b38997b14e984b0f84ab9cfc7cf272b731edecca19a483c

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/README.md

@@ -36,6 +36,8 @@ This scenario is for your standard user/admin.
 ```ruby
 # spec/support/experiences/user_experience.rb
 class UserExperience < Capybara::Experience
+  include Rails.application.routes.url_helpers
+
   def login(user)
     @user = user
     login_as user, scope: :user
@@ -98,7 +100,7 @@ RSpec.describe "sign up flow", feature: true do
   
   it "works" do
     behavior "user can sign up" do # behaviors are an added DSL by capybara-experiences to group interactions & assertions
-      guest_ux = GuestExpereince.new
+      guest_ux = GuestExperience.new
       guest_ux.navigate_to_sign_up
 
       guest_ux.sign_up(

data/capybara-experience.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "capybara", "~> 3.0"
 end

data/lib/capybara/experience/pool.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require "singleton"
+
+module Capybara
+  class Experience
+    class Pool < Hash
+      include Singleton
+
+      def [](key)
+        super(key) || begin
+          driver, _session_name, app_object_id = key.split(":")
+          take(driver: driver, app_object_id: app_object_id, key: key)
+        end
+      end
+
+      def take(driver: Capybara.current_driver, app_object_id: Capybara.app.object_id, key: nil)
+        session = idle.find { |s| s.mode == driver && s.app.object_id == app_object_id }
+        if session
+          idle.delete(session)
+          self[key] = delete(session_key(session)) if key
+        else
+          session = ::Capybara::Session.new(driver.to_sym, Capybara.app)
+          key ||= session_key(session)
+          self[key] = session
+        end
+
+        session
+      end
+
+      def idle
+        @idle ||= []
+      end
+
+      def taken
+        values - idle
+      end
+
+      def reset_idle!
+        each do |key, session|
+          self[session_key(session)] = delete(key)
+        end
+        @idle = values
+
+        nil
+      end
+
+      private
+
+      def session_key(session)
+        "#{session.mode}:#{session.object_id}:#{session.app.object_id}"
+      end
+    end
+  end
+end

data/lib/capybara/experience/rspec.rb

@@ -1,30 +1,37 @@
 # frozen_string_literal: true
-module BehaviorDSL
-    def behavior(name, &block)
-      metadata[:description_args].push(name)
-      refresh_description unless in_continuous_integration_env?
-      yield
-      metadata[:description_args].pop
-      refresh_description unless in_continuous_integration_env?
+
+module Capybara
+  class Experience
+    module BehaviorDSL
+      def behavior(name)
+        metadata[:description_args].push(name)
+        refresh_description unless in_continuous_integration_env?
+        yield
+        metadata[:description_args].pop
+        refresh_description unless in_continuous_integration_env?
+      end
+
+      private
+
+      def refresh_description
+        metadata[:description] = metadata[:description_args].join(" ")
+        metadata[:full_description] = [metadata[:example_group][:full_description]].concat(metadata[:description_args]).join(" ")
+      end
+
+      def metadata
+        RSpec.current_example.metadata
+      end
+
+      def in_continuous_integration_env?
+        ENV["CI"].present?
+      end
     end
-  
-    private
-  
-    def refresh_description
-      metadata[:description] = metadata[:description_args].join(" ")
-      metadata[:full_description] = [metadata[:example_group][:full_description]].concat(metadata[:description_args]).join(" ")
+
+    RSpec.configure do |config|
+      config.include BehaviorDSL
+      config.prepend_after :each, type: :feature, js: true do
+        Capybara::Experience::Pool.instance.reset_idle!
+      end
     end
-  
-    def metadata
-      RSpec.current_example.metadata
-    end
-  
-    def in_continuous_integration_env?
-      ENV["CI"].present?
-    end
-  end
-  
-  RSpec.configure do |config|
-    config.include BehaviorDSL
   end
-  
+end

data/lib/capybara/experience/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   class Experience
-    VERSION = "0.1.2"
+    VERSION = "0.3.1"
   end
 end

data/lib/capybara/experience.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
-require "capybara/experience/session"
+require "capybara/dsl"
+require "capybara/experience/pool"
 
 module Capybara
   class Experience
     include Capybara::DSL
-    include Rails.application.routes.url_helpers
-    include Warden::Test::Helpers
 
-    delegate :t, to: I18n
+    delegate :t, to: I18n if defined?(I18n)
 
     def initialize(driver_name: nil)
       @driver_name = driver_name
@@ -24,36 +23,35 @@ module Capybara
     delegate :driver, to: :page
 
     def page
-      @page ||= Experience::Session.next(driver: driver_name)
+      @page ||= Experience::Pool.instance.take(driver: driver_name)
+
+      Capybara::Screenshot.final_session_name = @page.object_id if defined?(Capybara::Screenshot)
+
+      @page
     end
 
     def self.wait_for_pending_requests
-      Experience::Session.pool.taken.each do |session|
+      Experience::Pool.taken.each do |session|
         session.server.try(:wait_for_pending_requests)
       end
     end
 
-    def save_and_open_screenshot_full(path = nil, options = {})
-      save_and_open_screenshot(path, options.merge(full: true))
-    end
+    class Error < StandardError; end
+
+    module UnifySessionPool
+      def page
+        Capybara::Screenshot.final_session_name = Capybara.session_name if defined?(Capybara::Screenshot)
 
-    def current_driver_adapter
-      adapter = ShowMeTheCookies.adapters[driver_name]
-      if adapter.nil?
-        raise(ShowMeTheCookies::UnknownDriverError, "Unsupported driver #{driver_name}, use one of #{ShowMeTheCookies.adapters.keys} or register your new driver with ShowMeTheCookies.register_adapter")
+        super
       end
-      adapter.new(page.driver)
-    end
 
-    def click_with_js(element)
-      xpath = element.path
-      execute_script <<~JS
-      document.evaluate('#{xpath}', document, null, XPathResult.ANY_TYPE, null)
-        .iterateNext()
-        .click()
-      JS
-    end
+      private
 
-    class Error < StandardError; end
+      def session_pool
+        @session_pool ||= Experience::Pool.instance
+      end
+    end
   end
+
+  singleton_class.prepend Experience::UnifySessionPool
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: capybara-experience
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Ryan Ong
 - Britt Lewis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Abstractions for Capybara to manage multiple user sessions, encapsulate
   shared test behavior, and semantically contextualize test code.
 email:
@@ -73,15 +87,15 @@ files:
 - capybara-experience.gemspec
 - lib/capybara-experience.rb
 - lib/capybara/experience.rb
+- lib/capybara/experience/pool.rb
 - lib/capybara/experience/rspec.rb
-- lib/capybara/experience/session.rb
 - lib/capybara/experience/version.rb
 homepage: https://github.com/ryanong/capybara-experience
 licenses: []
 metadata:
   homepage_uri: https://github.com/ryanong/capybara-experience
   source_code_uri: https://github.com/ryanong/capybara-experience
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.17
+signing_key:
 specification_version: 4
 summary: Simplify Capybara testing for larger applications
 test_files: []

data/lib/capybara/experience/session.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Capybara
-  class Experience
-    module Session
-      class << self
-        def next(driver:)
-          pool.next(driver)
-        end
-
-        def create(driver)
-          ::Capybara::Session.new(driver, Capybara.app)
-        end
-
-        def pool
-          @pool ||= Pool.new
-        end
-      end
-
-      class Pool
-        attr_accessor :idle, :taken
-
-        def initialize
-          @idle = []
-          @taken = []
-        end
-
-        def next(driver)
-          take_idle(driver) || create(driver)
-        end
-
-        def release
-          taken.each(&:reset!)
-          idle.concat(taken)
-          taken.clear
-        end
-
-        private
-
-        def take_idle(driver)
-          idle.find { |s| s.mode == driver }.tap do |session|
-            if session
-              idle.delete(session)
-              taken.push(session)
-            end
-          end
-        end
-
-        def create(driver)
-          ::Capybara::Experience::Session.create(driver).tap do |session|
-            taken.push(session)
-          end
-        end
-      end
-    end
-  end
-end