capybara-experience 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 481ac53f31988f2b33cf5fe8cf21f1e5a283ad0e33500b727384c66ac68ec18c
+  data.tar.gz: 58e8aa2c7002f148b85817b744a518f71b97e5f923cff42161e738487a000be3
+SHA512:
+  metadata.gz: 2c6b11b8f1306cd98fa93f10ab444b440466cc53a3341abb16581af2cbdfcbe86c8172d41c5854e50e581408ee7978f69998dfa45401dea3fe575063083af61d
+  data.tar.gz: 726c207dc4b809cb05da765029f6027eb876b6f16ef5c4e3163a3e2d0a0e24de6ac9af0dc2968b65b49b2bd4d1e9e339410b7bbdcdf9c99c69bbd0ca0b4a4c78

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capybara-experience.gemspec
+gemspec

data/README.md

@@ -0,0 +1,129 @@
+# Capybara::Experience
+We love Capybara! We think it's a great interface for testing Ruby web applications. But there are some pain points with the developer experience of using Capybara. We created this gem to address some of those pain points and added a few niceties along the way.
+
+Problems with/unsolved by vanilla Capybara:
+* Managing multiple user sessions in a single test, e.g. comparing customer-facing and admin experiences after interactions on either end.
+* Managing shared behavior for component interactions irrespective of page or test context
+* Provide semantically rich context to a collection of interactions & assertions, with clearer scope than comments 
+
+Capybara::Experience has a few core concepts:
+* Capabilities
+* Experiences 
+* Behaviors
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara-experience'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-experience
+
+## Usage
+
+### Basic
+This scenario is for your standard user/admin.
+1. We need to create a file for each experience
+
+```ruby
+# spec/support/experiences/user_experience.rb
+class UserExperience < Capybara::Experience
+  def login(user)
+    @user = user
+    login_as user, scope: :user
+    visit '/'
+    assert_text "#{@user.name} Welcome!"
+    self
+  end
+
+  private
+
+  attr_reader :user
+end
+```
+
+```ruby
+# spec/support/experiences/user_experience.rb
+class AdminExperience < Capybara::Experience
+  def initialize(*args)
+    super
+  end
+
+  def login(user)
+    @user = user
+    login_as user, scope: :admin
+    visit '/admin/login'
+    assert_text "Home"
+  end
+
+  private
+
+  attr_reader :user
+end
+```
+
+2. now we need to create some capabilities. These capability files associate to each page, imagine each capability is an api to a page.
+
+```ruby
+# spec/support/capabilities/sign_up.rb
+module Capabilities::SignUp
+  def navigate_to_sign_up
+    click_link "Sign Up"
+  end
+
+  def sign_up(email: , password: "password")
+    fill_in "email", with: email
+    fill_in "password", with: password
+    fill_in "password_confirmation", with: password
+    click_button "Submit"
+    assert_text "Welcome #{email}"
+  end
+end
+```
+
+3. write the spec
+```ruby
+# spec/features/sign_up_flow_spec.rb
+RSpec.describe "sign up flow", feature: true do
+  let(:guest_experience) { GuestExperience.new.extend(Capabilities::SignUp) }
+  let(:admin_experience) { AdminExperience.new.extend(Capabilities::Admin::ManageUser) }
+  
+  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.navigate_to_sign_up
+
+      guest_ux.sign_up(
+        email: "user@example.com"
+      )
+
+      expect(guest_ux).to have_content "user@example.com"
+      expect(guest_ux).to_not have_content "Login"
+    end
+
+    behavior "admin can see user" do
+      admin_ux = AdminExperience.new
+      admin_ux.login
+      admin_ux.to have_content "user@example.com"
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryanong/capybara-experience.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capybara/experience"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara-experience.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capybara/experience/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-experience"
+  spec.version       = Capybara::Experience::VERSION
+  spec.authors       = ["Ryan Ong", "Britt Lewis"]
+  spec.email         = ["ryanong@gmail.com", "brittlewis12@gmail.com"]
+
+  spec.summary       = %q{Simplify Capybara testing for larger applications}
+  spec.description   = %q{Abstractions for Capybara to manage multiple user sessions, encapsulate shared test behavior, and semantically contextualize test code.}
+  spec.homepage      = "https://github.com/ryanong/capybara-experience"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ryanong/capybara-experience"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/capybara/experience.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require "capybara/experience/version"
+require "capybara/experience/session"
+
+module Capybara
+  class Experience
+    include Capybara::DSL
+    include Rails.application.routes.url_helpers
+    include Warden::Test::Helpers
+
+    delegate :t, to: I18n
+
+    def initialize(driver_name: nil)
+      @driver_name = driver_name
+    end
+
+    def reload_page
+      visit current_url
+    end
+
+    def driver_name
+      @driver_name ||= Capybara.current_driver
+    end
+
+    delegate :driver, to: :page
+
+    def page
+      @page ||= Experiences::Session.next(driver: driver_name)
+    end
+
+    def self.wait_for_pending_requests
+      Experiences::Session.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
+
+    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")
+      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
+
+    class Error < StandardError; end
+  end
+end

data/lib/capybara/experience/rspec.rb

@@ -0,0 +1,30 @@
+# 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?
+    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
+  
+  RSpec.configure do |config|
+    config.include BehaviorDSL
+  end
+  

data/lib/capybara/experience/session.rb

@@ -0,0 +1,57 @@
+# 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

data/lib/capybara/experience/version.rb

@@ -0,0 +1,5 @@
+module Capybara
+  class Experience
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: capybara-experience
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ryan Ong
+- Britt Lewis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  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:
+- ryanong@gmail.com
+- brittlewis12@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capybara-experience.gemspec
+- lib/capybara/experience.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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simplify Capybara testing for larger applications
+test_files: []