match_table 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1647f8131554af5dbc383c249d74e02aee0a266c0c4e9fc4240b756c8be66f80
+  data.tar.gz: 203a90a3cad73ad4daae163e3fafcc8bf0f6026f407da4d7171cde4c819a34d5
+SHA512:
+  metadata.gz: 161f0b34b357ab60005624b8f713959e280176da89ab9c261a41670aed9aae731657e5ca712b6ba9ad5800fce300970c2f3ac03e118e34aac361d08e6f8e85ee
+  data.tar.gz: cbd4fed84e7e0171bdfe7eef2b585651a9f483b61660b154496b864cf5209d992761d6e28b36e9d831b44a22e187ef09849597d15136532d779eb60c41dc86df

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2025-04-15
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 deTASO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# MatchTable
+
+Adds a `match_table` matcher for your Capybara system specs.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add match_table
+```
+
+## Usage
+
+In your system specs:
+
+```ruby
+# Matches rows but doesn't care about the order or extra rows
+expect(page).to match_table(:foo_table).with_rows(
+  {
+    "Name" => "John Smith",
+    "Status" => "Active",
+  }
+)
+
+# Matches rows in the order they are defined and fails if there are extra rows
+expect(page).to match_table(:foo_table).with_exact_rows(
+  {
+    "Name" => "John Smith",
+    "Status" => "Active",
+  }
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/detaso/match_table>.

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "standard/rake"
+
+task default: :standard

data/lib/match_table/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MatchTable
+  VERSION = "1.0.0"
+end

data/lib/match_table.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require_relative "match_table/version"
+require "rspec/expectations"
+require "capybara"
+
+module MatchTable
+end
+
+RSpec::Matchers.define :match_table do |table|
+  match do |page|
+    @table = table
+
+    @found_table = false
+    expect(page).to have_table @table
+    @found_table = true
+
+    expected_headers = @expected_rows.first.keys
+
+    same_headers =
+      @expected_rows.all? do |row|
+        row.keys == expected_headers
+      end
+
+    raise ArgumentError, "all rows must have the same headers" unless same_headers
+
+    begin
+      # We'll rerun this block until our expectations are met or we time out.
+      synchronize do
+        @failures = []
+        find_elements_on_page
+
+        header_positions =
+          expected_headers.each_with_object({}) do |header, hash|
+            position = @actual_headers.find_index { |actual_header| actual_header.start_with?(header) }
+            unless position.nil?
+              hash[header] = position
+            end
+          end
+
+        matched_rows = []
+        @actual_rows.each do |actual_row|
+          matched_rows << match_row(header_positions:, actual_row:)
+        end
+
+        @actual = matched_rows
+        @expected_as_array = Array(@expected_rows)
+
+        # Grab the failures from these expectations so we can use their failure messages
+        RSpec::Support.with_failure_notifier(append_to_failures_array_notifier) do
+          case @mode
+          when :exact
+            expect(actual).to eq(expected_as_array)
+          when :include
+            expect(actual).to include(*expected_as_array)
+          end
+        end
+
+        raise Capybara::ExpectationNotMet unless @failures.empty?
+      end
+    rescue Capybara::ExpectationNotMet
+      false
+    end
+
+    @failures.empty?
+  end
+
+  # Match the table exactly with the provided rows in order.
+  chain :with_exact_rows do |*rows|
+    @mode = :exact
+    @expected_rows = rows
+  end
+
+  # Ensure the table includes the provided rows, but not necessarily in order.
+  chain :with_rows do |*rows|
+    @mode = :include
+    @expected_rows = rows
+  end
+
+  failure_message do |page|
+    if !@found_table
+      "unable to find table \"#{table}\" on page"
+    else
+      <<~MESSAGE
+        found table "#{table}" on page, with headers:
+        #{@actual_headers}
+        but rows did not match expected values:
+        #{@failures.map(&:message).join("\n")}
+      MESSAGE
+    end
+  end
+
+  def synchronize
+    Capybara.current_session.document.synchronize do
+      yield
+    end
+  end
+
+  def find_table(identifier)
+    if identifier.is_a?(Symbol)
+      find_by_id(identifier)
+    else
+      find(:table, identifier)
+    end
+  end
+
+  def find_elements_on_page
+    table = find_table(@table)
+
+    @actual_headers =
+      table.find("thead").all("th").map(&:text)
+
+    @actual_rows = []
+
+    rows = table.find("tbody:not(.contents)").all("tr[data-table-target='row']:not([data-accordion-content] table tr)").presence ||
+      table.find("tbody:not(.contents)").all("tr[data-table-target='row']")
+
+    rows.each do |row|
+      cells = row.all("td")
+      @actual_rows << cells.map(&:text)
+    end
+  end
+
+  def match_row(header_positions:, actual_row:)
+    header_positions.each_with_object({}) do |(header, position), matched_row|
+      matched_row[header] = actual_row[position]
+    end
+  end
+
+  def append_to_failures_array_notifier
+    lambda { |failure, _opts| @failures << failure }
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: match_table
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Schlesinger
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Capybara's built-in table matchers leave a lot to be desired. `match_table`
+  is a matcher that allows you to match tables in your system specs with a lot more
+  flexibility and much improved failure messages.
+email:
+- ryan@ryanschlesinger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/match_table.rb
+- lib/match_table/version.rb
+homepage: https://github.com/detaso/match_table
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/detaso/match_table
+  source_code_uri: https://github.com/detaso/match_table
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Adds a `match_table` matcher for your Capybara system specs.
+test_files: []