capybara_test_helpers 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f491ad2f4d94ecd7e159466955e97b5e87117a5bb3fdb8eb907139e25fcb7ef1
-  data.tar.gz: 0f2d79cf1b201ffc6f4a2b7601b2550c85e626f2ebe32f367538e49a5adfcde2
+  metadata.gz: 9e4f6226edd7ecb46f2d8376f129d26e8ee0156ed0df1fd1083881a224489da8
+  data.tar.gz: da483ed245cd972f66b291e31c5345bf9b451c8f26c866284d7f35892043a4b6
 SHA512:
-  metadata.gz: c323a983bc4b02cde81006a986388c8cb1a5c88c4db8a8c4b9a2bc746765c8b6b46487593b25ce2a46628865b6b2bb54cbb6c1afeeaea7965667778e60044e2b
-  data.tar.gz: 7b77a14b74c33d4a934071014a43db8ed63c184fea3e5ef8fc91a1ed4439f7e3a40398b87cd763249771b6a813e3a608fcd1caff93c941d4baa97db60f711b7e
+  metadata.gz: 66ee90ceda7582b79b2ffc905f875422ad7122a3a9a29c589b9df2bd63417ee81c94f6fa66c2d26568ff8cb01e835c8dcc30e4e7970e6ece174376941f07ac39
+  data.tar.gz: c75546cc4a3ea671b22ccf685fba84a2767f3d0ac2e652b214f144eb28ea0a284b8f38198596b03c487f81d49bea0e447ea608b0deeaf42bf2f19d46a3fcae5a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Upcoming Changes
+
+*   Add `has?` alias for `has_selector?`.
+*   Delegate `have` to the RSpec collection matcher when passing an Integer.
+
 ## Capybara Test Helpers 1.0.0 (2020-11-17) ##
 
 *   Initial Release.

data/README.md

@@ -2,7 +2,6 @@
 Capybara Test Helpers
 <p align="center">
 <a href="https://github.com/ElMassimo/capybara_test_helpers/actions"><img alt="Build Status" src="https://github.com/ElMassimo/capybara_test_helpers/workflows/build/badge.svg"/></a>
-<a href="https://inch-ci.org/github/ElMassimo/capybara_test_helpers"><img alt="Inline docs" src="https://inch-ci.org/github/ElMassimo/capybara_test_helpers.svg"/></a>
 <a href="https://codeclimate.com/github/ElMassimo/capybara_test_helpers"><img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/capybara_test_helpers/badges/gpa.svg"/></a>
 <a href="https://codeclimate.com/github/ElMassimo/capybara_test_helpers"><img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/capybara_test_helpers/badges/coverage.svg"/></a>
 <a href="https://rubygems.org/gems/capybara_test_helpers"><img alt="Gem Version" src="https://img.shields.io/gem/v/capybara_test_helpers.svg?colorB=e9573f"/></a>
@@ -14,8 +13,9 @@ Capybara Test Helpers
 an opinionated library built on top of [capybara], that encourages good testing
 practices based on encapsulation and reuse.
 
-Write tests that everyone can understand, and leverage your Ruby skills to keep tests __easy to read and easy to change__.
+Write tests that everyone can understand, and leverage your Ruby skills to keep them __easy to read and easy to change__.
 
+[docs]: https://capybara-test-helpers.netlify.app/
 [capybara]: https://github.com/teamcapybara/capybara
 [capybara dsl]: https://github.com/teamcapybara/capybara#the-dsl
 [capybara querying]: https://github.com/teamcapybara/capybara#querying
@@ -27,7 +27,7 @@ Write tests that everyone can understand, and leverage your Ruby skills to keep
 [testing_robots]: https://jakewharton.com/testing-robots/
 [page_objects]: https://martinfowler.com/bliki/PageObject.html
 [rspec_injection]: https://github.com/ElMassimo/capybara_test_helpers/blob/master/examples/rails_app/spec/system/cities_spec.rb#L7
-[rspec_global_injection]: https://github.com/ElMassimo/capybara_test_helpers/blob/master/examples/rails_app/spec/support/default_test_helpers.rb#L8
+[rspec_global_injection]: https://github.com/ElMassimo/capybara_test_helpers/blob/master/examples/rails_app/spec/system/support/default_test_helpers.rb#L8
 [cucumber_injection]: https://github.com/ElMassimo/capybara_test_helpers/blob/master/examples/rails_app/features/step_definitions/city_steps.rb#L3
 [example app]: https://github.com/ElMassimo/capybara_test_helpers/blob/master/examples/rails_app
 [capybara_test_helpers_tests]: https://github.com/ElMassimo/capybara_test_helpers/blob/master/spec
@@ -37,6 +37,8 @@ Write tests that everyone can understand, and leverage your Ruby skills to keep
 [rails_integration]: https://github.com/ElMassimo/capybara_test_helpers/commit/c512e39987215e30227dad45e775480bc1348325
 [cucumber_integration]: https://github.com/ElMassimo/capybara_test_helpers/commit/68e20cb40ba409c50f88f8b745eb908fb067a0aa
 
+Check out the [documentation site][docs] for more information.
+
 ## Why? 🤔
 
 [`capybara`][capybara] is a great library for integration tests in Ruby,
@@ -124,65 +126,63 @@ from Cucumber to RSpec.
 You can define a test helper by subclassing `Capybara::TestHelper`, which has
 full access to the Capybara DSL.
 
-When using Rails, you can generate a test helper by running:
-
-      rails g test_helper users
-
 ```ruby
-class UsersTestHelper < Capybara::TestHelper
+class CitiesTestHelper < Capybara::TestHelper
+  use_test_helpers(:form, :table)
+
 # Selectors: Semantic aliases for elements, a useful abstraction.
   SELECTORS = {
-    el: 'table.users',
-    form: '.user-form',
-    submit_button: [:button, type: 'submit'],
+    el: 'table.cities',
   }
 
 # Getters: A convenient way to get related data or nested elements.
-  def row_for(user)
-    within { find(:table_row, { 'Name' => user.name }) }
+  def row_for(city)
+    within { table.row_for(city.name) }
   end
 
 # Actions: Encapsulate complex actions to provide a cleaner interface.
-  def add(attrs)
-    click_on('Add User')
-    save_user(**attrs)
+  def add(**args)
+    click_on('New City')
+    save_city(**args)
+    yield(form) if block_given?
   end
 
-  def edit(user, with:)
-    row_for(user).click_on('Edit')
-    save_user(**with)
+  def edit(city, with:)
+    row_for(city).click_on('Edit')
+    save_city(**with)
   end
 
-  def delete(user)
-    row_for(user).click_on('Delete')
-    accept_confirm
+  def delete(city)
+    accept_confirm { row_for(city).click_on('Destroy') }
   end
 
   private \
-  def save_user(name:, language:)
-    within(:form) {
-      fill_in('Name', with: name)
-      choose('Language', option: language)
-      submit_button.click
+  def save_city(name:)
+    form.within {
+      fill_in 'Name', with: name
+      form.save
     }
   end
 
-# Assertions: Allow to check on element properties while keeping it DRY.
-  def have_user(name:, language:)
-    columns = { 'Name' => name, 'Language' => language }
-    within { have(:table_row, columns) }
+# Assertions: Check on element properties, used with `should` and `should_not`.
+  def have_city(name)
+    within { have(:table_row, { 'Name' => name }) }
+  end
+
+# Background: Helpers to add/modify/delete data in the database or session.
+  def given_there_is_a_city(name)
+    City.create!(name: name)
   end
 end
 ```
 
-To make the test helper available you can [use the `test_helpers` option in RSpec][rspec_injection],
-or [call `use_test_helpers` in Cucumber step definitions][cucumber_injection].
+When using Rails, you can generate a test helper by running:
 
-For test helpers that you expect to use very often, [`use_test_helpers` allows you to make them available globally][rspec_global_injection].
+    $ rails g test_helper users
 
 ### Writing a Test with Helpers ✅
 
-You can find [this working example](https://github.com/ElMassimo/capybara_test_helpers/blob/master/examples/rails_app/spec/features/cities_spec.rb) and more in the [example app] and the [Capybara tests][capybara_test_helpers_tests].
+You can find [this working example](https://github.com/ElMassimo/capybara_test_helpers/blob/master/examples/rails_app/spec/system/cities_spec.rb) and more in the [example app] and the [Capybara tests][capybara_test_helpers_tests].
 
 ```ruby
 require 'rails_helper'
@@ -216,9 +216,16 @@ RSpec.describe 'Cities', test_helpers: [:cities] do
 end
 ```
 
+To make the test helper available you can use the [`test_helpers` option][rspec_injection]
+in a `describe`, `context` or `scenario` as seen above.
+
+When using Cucumber, you may call [`use_test_helpers`][cucumber_injection] in the step definitions.
+
+Finally, for test helpers that you expect to use very often, you can [`use_test_helpers`][rspec_global_injection] in an RSpec helper module to make them available globally.
+
 ## DSL 🛠
 
-A documentation website with the full API and examples is coming soon.
+A [documentation website][docs] with the full API and examples is [now available][docs] :shipit:
 
 Every single method in the [Capybara DSL] is available inside test helpers, as
 well as the [built-in RSpec matchers][rspec matchers].
@@ -228,8 +235,8 @@ well as the [built-in RSpec matchers][rspec matchers].
 You can encapsulate locators for commonly used elements to avoid hardcoding them
 in different tests.
 
-As a result, if the implementation changes, there are less places that need to
-be updated, making it faster to update tests after UI changes.
+As a result, if the UI changes there are less places that need to be updated in
+the tests 😃
 
 ```ruby
 class FormTestHelper < BaseTestHelper
@@ -327,13 +334,10 @@ they are both available because we are using an existing assertion.
 #### Advanced Assertions ⚙️
 
 Sometimes built-in assertions are not enough, and you need to use an expectation
-directly. Test helpers provide a `to_or` and `not_to` method, similar to [the
-technique described in this post][positive and negative assertions] that you
+directly. Test helpers provide [`to_or` and `not_to` methods][positive and negative assertions] that you
 can use to implement an assertion that you can use with `should` or `should_not`.
 
 ```ruby
-# frozen_string_literal: true
-
 class CurrentPageTestHelper < BaseTestHelper
 # Getters: A convenient way to get related data or nested elements.
   def fullscreen?

data/lib/capybara_test_helpers/assertions.rb

@@ -93,7 +93,14 @@ module CapybaraTestHelpers::Assertions
     CapybaraTestHelpers.define_helper_method(self, method_name, target: :page, assertion: true, inject_test_helper: false)
   end
 
-  alias have have_selector
+  # Public: Allows to call have_selector with a shorter syntax.
+  def have(*args, **kwargs, &filter)
+    if args.first.is_a?(Integer)
+      ::RSpec::CollectionMatchers::Have.new(*args, **kwargs)
+    else
+      have_selector(*args, **kwargs, &filter)
+    end
+  end
 
   # Public: Allows to check on any input value asynchronously.
   def have_value(expected_value, **options)

data/lib/capybara_test_helpers/matchers.rb

@@ -52,4 +52,6 @@ module CapybaraTestHelpers::Matchers
   ].each do |method_name|
     CapybaraTestHelpers.define_helper_method(self, method_name, target: :to_capybara_node)
   end
+
+  alias has? has_selector?
 end

data/lib/capybara_test_helpers/rspec.rb

@@ -26,7 +26,7 @@ RSpec.configure do |config|
   }
 
   # Allow injecting test helpers in a feature or scenario.
-  %i[feature system view].each do |type|
+  types.each do |type|
     config.include(CapybaraTestHelpers::DependencyInjection, type: type)
     config.before(:each, type: type, &inject_test_helpers)
   end

data/lib/capybara_test_helpers/version.rb

@@ -2,5 +2,5 @@
 
 # Easily write fluent Page Objects for Capybara in Ruby.
 module CapybaraTestHelpers
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/generators/test_helper/test_helper_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'capybara_test_helpers'
 require 'rails/generators/named_base'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara_test_helpers
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Maximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,7 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: Write tests that everyone can understand, and leverage your Ruby skills
+  to keep them easy to read and easy to change.
 email:
 - maximomussini@gmail.com
 executables: []