rails-jsdom 0.1.0

data/lib/rails_jsdom/turbo_stream_deliveries.rb

@@ -0,0 +1,25 @@
+module RailsJsdom
+  class TurboStreamDeliveries # :nodoc:
+    def initialize
+      @delivered = {}
+    end
+
+    def undelivered_messages(session, streams)
+      previously_delivered = @delivered.fetch(session, {})
+      @delivered[session] = streams.to_h { |stream| [ stream, broadcasts(stream).size ] }
+      streams.flat_map { |stream| new_messages(stream, previously_delivered) }
+    end
+
+    private
+
+    def new_messages(stream, previously_delivered)
+      sent = broadcasts(stream)
+      unseen = sent.drop(previously_delivered.fetch(stream, sent.size))
+      unseen.map { |payload| ActiveSupport::JSON.decode(payload) }.grep(String)
+    end
+
+    def broadcasts(stream)
+      ActionCable.server.pubsub.broadcasts(stream)
+    end
+  end
+end

data/lib/rails_jsdom/version.rb

@@ -0,0 +1,4 @@
+module RailsJsdom
+  # The version of the rails-jsdom gem.
+  VERSION = "0.1.0".freeze
+end

data/lib/rails_jsdom.rb

@@ -0,0 +1,83 @@
+require "json"
+require "open3"
+require_relative "rails_jsdom/version"
+
+# Browserless interaction tests for Rails apps built with Stimulus, Turbo and
+# importmap.
+#
+# Write tests with RailsJsdom::TestCase. Its helpers are documented in
+# RailsJsdom::TestHelper.
+module RailsJsdom
+  # Raised when an action fails in the page: an element is not found or
+  # matches more than once, a JavaScript error or unexpected dialog occurs, or
+  # the Node process exits.
+  class Error < StandardError; end
+
+  # :stopdoc:
+
+  RUNNER = File.expand_path("rails_jsdom/runner.js", __dir__)
+  REMOTE = %r{\A[a-z][a-z0-9+.-]*://}i
+  HIDDEN_SELECTOR = "[hidden], template, script, style, noscript, dialog:not([open]), [style*='display: none'], [style*='display:none']".freeze
+  TIMER_HORIZON = 1000
+
+  class << self
+    def bridge
+      bridges[Process.pid] ||= Bridge.new(command: [ "node", RUNNER ], setup: setup, logger: Rails.logger)
+    end
+
+    def setup
+      {
+        command: "setup",
+        root: Rails.root.to_s,
+        controllers: Rails.root.join("app/javascript/controllers").to_s,
+        modules: modules,
+        stubs: remote_modules,
+        directories: directories,
+        horizon: TIMER_HORIZON,
+        hidden: HIDDEN_SELECTOR
+      }
+    end
+
+    def modules
+      packages.reject { |_name, path| path.match?(REMOTE) }.transform_values { |path| Rails.application.assets.load_path.find(path)&.path&.to_s }
+    end
+
+    def remote_modules
+      packages.select { |_name, path| path.match?(REMOTE) }.keys
+    end
+
+    def directories
+      Rails.application.importmap.directories.values.to_h { |directory| [ directory.under, Rails.root.join(directory.dir).to_s ] }
+    end
+
+    def keys(keys)
+      keys.map { |key| key.is_a?(Array) ? key_entry(key.last).merge(modifiers: key[0...-1].map(&:to_s)) : key_entry(key) }
+    end
+
+    def document(html)
+      "<!DOCTYPE html><html><head></head><body>#{html}</body></html>"
+    end
+
+    private
+
+    def key_entry(key)
+      key.is_a?(Symbol) ? { key: key.to_s } : { text: key.to_s }
+    end
+
+    def packages
+      Rails.application.importmap.packages.transform_values(&:path)
+    end
+
+    def bridges
+      @bridges ||= {}
+    end
+  end
+end
+
+require_relative "rails_jsdom/bridge"
+require_relative "rails_jsdom/query"
+require_relative "rails_jsdom/turbo_stream_deliveries"
+require_relative "rails_jsdom/element"
+require_relative "rails_jsdom/test_helper"
+require_relative "rails_jsdom/page"
+require_relative "rails_jsdom/test_case"

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rails-jsdom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jake Howerton
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actioncable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: rails-jsdom runs your real Rails pages, Stimulus controllers and Turbo
+  in a persistent Node + jsdom process, routing page fetches back into Rails in-process.
+  Interaction tests read like system tests without Capybara, a server or a browser.
+email:
+- jake.howerton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/generators/rails_jsdom/install/install_generator.rb
+- lib/rails_jsdom.rb
+- lib/rails_jsdom/bridge.rb
+- lib/rails_jsdom/element.rb
+- lib/rails_jsdom/page.rb
+- lib/rails_jsdom/query.rb
+- lib/rails_jsdom/runner.js
+- lib/rails_jsdom/runtime.js
+- lib/rails_jsdom/test_case.rb
+- lib/rails_jsdom/test_helper.rb
+- lib/rails_jsdom/turbo_stream_deliveries.rb
+- lib/rails_jsdom/version.rb
+homepage: https://github.com/jakehow/rails-jsdom
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jakehow/rails-jsdom
+  source_code_uri: https://github.com/jakehow/rails-jsdom
+  documentation_uri: https://jakehow.github.io/rails-jsdom/
+  changelog_uri: https://github.com/jakehow/rails-jsdom/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/jakehow/rails-jsdom/issues
+  rubygems_mfa_required: 'true'
+post_install_message: 'rails-jsdom: set up interaction tests in your app with `bin/rails
+  generate rails_jsdom:install`.'
+rdoc_options:
+- "--main"
+- README.md
+- "--markup"
+- markdown
+- "--title"
+- rails-jsdom
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Browserless Stimulus and Turbo interaction tests for Rails, on jsdom.
+test_files: []