dommy-rails 0.9.0

data/lib/dommy/rails/rspec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+begin
+  require "rspec/expectations"
+rescue LoadError => e
+  raise LoadError, "dommy-rails RSpec integration requires rspec-expectations. Add `gem \"rspec\"` or `gem \"rspec-expectations\"` to your Gemfile.", e.backtrace
+end
+
+require "dommy/rspec/capy_style_matchers"
+require_relative "../rails"
+require_relative "rspec/matchers"
+require_relative "rspec/integration"

data/lib/dommy/rails/stimulus.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Dommy
+  module Rails
+    module Stimulus
+      module_function
+
+      # ----- Scope-level predicates (any element in scope matches) -----
+
+      def controller?(scope, name)
+        scope.query_selector_all("[data-controller]").to_a.any? { |element| has_controller?(element, name) }
+      end
+
+      def action?(scope, action)
+        scope.query_selector_all("[data-action]").to_a.any? { |element| has_action?(element, action) }
+      end
+
+      def target?(scope, controller, target)
+        scope.query_selector_all("[data-#{controller}-target]").to_a.any? { |element| has_target?(element, controller, target) }
+      end
+
+      def value?(scope, controller, key, value)
+        scope.query_selector_all("[data-#{controller}-#{key}-value]").to_a.any? { |element| has_value?(element, controller, key, value) }
+      end
+
+      # ----- Element-level predicates -----
+
+      def has_controller?(element, name)
+        controllers = element.get_attribute("data-controller").to_s.split
+        controllers.include?(name.to_s)
+      end
+
+      def has_action?(element, action)
+        actions = element.get_attribute("data-action").to_s.split
+        actions.any? { |a| a == action.to_s || a.end_with?("->#{action}") }
+      end
+
+      def has_target?(element, controller, target)
+        element.has_attribute?("data-#{controller}-target") &&
+          element.get_attribute("data-#{controller}-target").to_s.split.include?(target.to_s)
+      end
+
+      def has_value?(element, controller, key, value)
+        attr_name = "data-#{controller}-#{key}-value"
+        return false unless element.has_attribute?(attr_name)
+        element.get_attribute(attr_name).to_s == value.to_s
+      end
+    end
+  end
+end

data/lib/dommy/rails/turbo_stream.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Dommy
+  module Rails
+    module TurboStream
+      module_function
+
+      def parse(body)
+        Dommy.parse(body).document.query_selector_all("turbo-stream").to_a
+      end
+
+      def find(body, action:, target:)
+        parse(body).find do |stream|
+          stream.get_attribute("action") == action.to_s && stream.get_attribute("target") == target.to_s
+        end
+      end
+
+      def matches?(body, action:, target:)
+        !find(body, action: action, target: target).nil?
+      end
+
+      # The <template> payload of a stream element, parsed as its own
+      # document (nil when the stream has no template).
+      def fragment_document(stream)
+        fragment = stream.query_selector("template")&.inner_html
+        fragment ? Dommy.parse(fragment).document : nil
+      end
+
+      def fragment_for(body, action:, target:)
+        stream = find(body, action: action, target: target)
+        stream ? stream.query_selector("template")&.inner_html : nil
+      end
+
+      def fragment_document_for(body, action:, target:)
+        stream = find(body, action: action, target: target)
+        stream ? fragment_document(stream) : nil
+      end
+    end
+  end
+end

data/lib/dommy/rails/url_matcher.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "url_normalizer"
+
+module Dommy
+  module Rails
+    # Adapts Rails URL normalization to the matcher protocol accepted by
+    # Dommy::Internal::ElementMatching.attribute_matches?, so `href:` /
+    # `action:` criteria absorb scheme/host, query-parameter order,
+    # HTML-escaped `&`, and trailing-slash differences.
+    class UrlMatcher
+      def initialize(expected)
+        @expected = expected
+      end
+
+      def matches?(actual)
+        case @expected
+        when Regexp
+          actual.to_s.match?(@expected)
+        else
+          UrlNormalizer.equal?(@expected, actual)
+        end
+      end
+    end
+  end
+end

data/lib/dommy/rails/url_normalizer.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "cgi"
+require "uri"
+
+module Dommy
+  module Rails
+    # Normalizes URLs so Rails URL-helper output and rendered HTML
+    # compare equal despite representational differences.
+    #
+    # Deliberately lenient: scheme and host are dropped, query
+    # parameters are sorted, HTML entities are unescaped, and trailing
+    # slashes are removed. Strict external-host matching is out of
+    # scope (see README).
+    module UrlNormalizer
+      module_function
+
+      def equal?(expected, actual)
+        normalize(expected) == normalize(actual)
+      end
+
+      def normalize(url)
+        url = url.to_s
+        return "" if url.empty?
+
+        # Attribute values may arrive HTML-escaped (e.g. & in raw
+        # response bodies).
+        url = CGI.unescapeHTML(url)
+
+        uri = URI.parse(url)
+        path = uri.path.to_s
+        path = path.chomp("/") unless path == "/"
+
+        query = if uri.query
+          params = URI.decode_www_form(uri.query).sort_by { |k, _| k }
+          URI.encode_www_form(params)
+        end
+
+        [path, query].compact.join("?")
+      rescue URI::InvalidURIError
+        url
+      end
+    end
+  end
+end

data/lib/dommy/rails/version.rb

@@ -0,0 +1,5 @@
+module Dommy
+  module Rails
+    VERSION = "0.9.0"
+  end
+end

data/lib/dommy/rails.rb

@@ -0,0 +1,18 @@
+require "dommy"
+require_relative "rails/version"
+require_relative "rails/form_inspector"
+require_relative "rails/turbo_stream"
+require_relative "rails/stimulus"
+require_relative "rails/lint"
+require_relative "rails/url_normalizer"
+require_relative "rails/url_matcher"
+require_relative "rails/mail_part"
+require_relative "rails/match_target"
+require_relative "rails/dom_source"
+require_relative "rails/page_inspector"
+require_relative "rails/aria_snapshot_matching"
+
+module Dommy
+  module Rails
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: dommy-rails
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- takahashim
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dommy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Rails-specific matchers and assertions for Dommy, including form helper
+  understanding, Turbo Stream support, Stimulus attribute checking, and HTML quality
+  linting.
+email:
+- takahashimm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/dommy/rails.rb
+- lib/dommy/rails/aria_snapshot_matching.rb
+- lib/dommy/rails/browser_spec.rb
+- lib/dommy/rails/dom_source.rb
+- lib/dommy/rails/form_inspector.rb
+- lib/dommy/rails/lint.rb
+- lib/dommy/rails/mail_part.rb
+- lib/dommy/rails/match_target.rb
+- lib/dommy/rails/minitest.rb
+- lib/dommy/rails/minitest/assertions.rb
+- lib/dommy/rails/minitest/integration.rb
+- lib/dommy/rails/page_inspector.rb
+- lib/dommy/rails/rspec.rb
+- lib/dommy/rails/rspec/browser.rb
+- lib/dommy/rails/rspec/integration.rb
+- lib/dommy/rails/rspec/matchers.rb
+- lib/dommy/rails/stimulus.rb
+- lib/dommy/rails/turbo_stream.rb
+- lib/dommy/rails/url_matcher.rb
+- lib/dommy/rails/url_normalizer.rb
+- lib/dommy/rails/version.rb
+homepage: https://github.com/takahashim/dommy
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Rails integration for Dommy DOM testing
+test_files: []